curl --request POST \
--url https://api.gospott.com/appointments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"candidateId": "<string>",
"startTime": "2026-08-12T08:30:00.000Z",
"endTime": "2026-08-12T09:15:00.000Z",
"message": {
"subject": "Intake",
"body": "<string>"
},
"location": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0
},
"applicationId": "<string>"
}
'import requests
url = "https://api.gospott.com/appointments"
payload = {
"candidateId": "<string>",
"startTime": "2026-08-12T08:30:00.000Z",
"endTime": "2026-08-12T09:15:00.000Z",
"message": {
"subject": "Intake",
"body": "<string>"
},
"location": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0
},
"applicationId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidateId: '<string>',
startTime: '2026-08-12T08:30:00.000Z',
endTime: '2026-08-12T09:15:00.000Z',
message: {subject: 'Intake', body: JSON.stringify('<string>')},
location: {
street1: '<string>',
street2: '<string>',
postalCode: '<string>',
city: '<string>',
region: '<string>',
state: '<string>',
country: '<string>',
latitude: 0,
longitude: 0
},
applicationId: '<string>'
})
};
fetch('https://api.gospott.com/appointments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gospott.com/appointments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'candidateId' => '<string>',
'startTime' => '2026-08-12T08:30:00.000Z',
'endTime' => '2026-08-12T09:15:00.000Z',
'message' => [
'subject' => 'Intake',
'body' => '<string>'
],
'location' => [
'street1' => '<string>',
'street2' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'region' => '<string>',
'state' => '<string>',
'country' => '<string>',
'latitude' => 0,
'longitude' => 0
],
'applicationId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gospott.com/appointments"
payload := strings.NewReader("{\n \"candidateId\": \"<string>\",\n \"startTime\": \"2026-08-12T08:30:00.000Z\",\n \"endTime\": \"2026-08-12T09:15:00.000Z\",\n \"message\": {\n \"subject\": \"Intake\",\n \"body\": \"<string>\"\n },\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"applicationId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gospott.com/appointments")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"candidateId\": \"<string>\",\n \"startTime\": \"2026-08-12T08:30:00.000Z\",\n \"endTime\": \"2026-08-12T09:15:00.000Z\",\n \"message\": {\n \"subject\": \"Intake\",\n \"body\": \"<string>\"\n },\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"applicationId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/appointments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidateId\": \"<string>\",\n \"startTime\": \"2026-08-12T08:30:00.000Z\",\n \"endTime\": \"2026-08-12T09:15:00.000Z\",\n \"message\": {\n \"subject\": \"Intake\",\n \"body\": \"<string>\"\n },\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"applicationId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}Plan an appointment for a candidate
Creates an appointment for a candidate. Pass applicationId to attach the appointment to one of the applications of that candidate, and location to record where it takes place.
curl --request POST \
--url https://api.gospott.com/appointments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"candidateId": "<string>",
"startTime": "2026-08-12T08:30:00.000Z",
"endTime": "2026-08-12T09:15:00.000Z",
"message": {
"subject": "Intake",
"body": "<string>"
},
"location": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0
},
"applicationId": "<string>"
}
'import requests
url = "https://api.gospott.com/appointments"
payload = {
"candidateId": "<string>",
"startTime": "2026-08-12T08:30:00.000Z",
"endTime": "2026-08-12T09:15:00.000Z",
"message": {
"subject": "Intake",
"body": "<string>"
},
"location": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0
},
"applicationId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidateId: '<string>',
startTime: '2026-08-12T08:30:00.000Z',
endTime: '2026-08-12T09:15:00.000Z',
message: {subject: 'Intake', body: JSON.stringify('<string>')},
location: {
street1: '<string>',
street2: '<string>',
postalCode: '<string>',
city: '<string>',
region: '<string>',
state: '<string>',
country: '<string>',
latitude: 0,
longitude: 0
},
applicationId: '<string>'
})
};
fetch('https://api.gospott.com/appointments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gospott.com/appointments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'candidateId' => '<string>',
'startTime' => '2026-08-12T08:30:00.000Z',
'endTime' => '2026-08-12T09:15:00.000Z',
'message' => [
'subject' => 'Intake',
'body' => '<string>'
],
'location' => [
'street1' => '<string>',
'street2' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'region' => '<string>',
'state' => '<string>',
'country' => '<string>',
'latitude' => 0,
'longitude' => 0
],
'applicationId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gospott.com/appointments"
payload := strings.NewReader("{\n \"candidateId\": \"<string>\",\n \"startTime\": \"2026-08-12T08:30:00.000Z\",\n \"endTime\": \"2026-08-12T09:15:00.000Z\",\n \"message\": {\n \"subject\": \"Intake\",\n \"body\": \"<string>\"\n },\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"applicationId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gospott.com/appointments")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"candidateId\": \"<string>\",\n \"startTime\": \"2026-08-12T08:30:00.000Z\",\n \"endTime\": \"2026-08-12T09:15:00.000Z\",\n \"message\": {\n \"subject\": \"Intake\",\n \"body\": \"<string>\"\n },\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"applicationId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/appointments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidateId\": \"<string>\",\n \"startTime\": \"2026-08-12T08:30:00.000Z\",\n \"endTime\": \"2026-08-12T09:15:00.000Z\",\n \"message\": {\n \"subject\": \"Intake\",\n \"body\": \"<string>\"\n },\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"applicationId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}Authorizations
API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.
Body
Identifier of the candidate the appointment is planned for.
1Kind of appointment being planned.
ONLINE_MEETING, INTERVIEW, REGISTRATION Moment the appointment starts.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$"2026-08-12T08:30:00.000Z"
Moment the appointment ends. Must be after startTime.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$"2026-08-12T09:15:00.000Z"
Subject and body describing the appointment.
Show child attributes
Show child attributes
Physical location of the appointment. Omit for appointments without location.
Show child attributes
Show child attributes
Identifier of the application this appointment belongs to. Must be an application of the same candidate.
1Response
The appointment was created. Returns its id.
1Was this page helpful?