Create a candidate to-do
curl --request POST \
--url https://api.gospott.com/candidates/{id}/todos \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"message": {
"subject": "<string>",
"body": "<string>"
},
"dueDate": "2023-11-07T05:31:56Z",
"applicationId": "<string>",
"type": "VISIT_URL",
"url": "<string>"
}
'import requests
url = "https://api.gospott.com/candidates/{id}/todos"
payload = {
"message": {
"subject": "<string>",
"body": "<string>"
},
"dueDate": "2023-11-07T05:31:56Z",
"applicationId": "<string>",
"type": "VISIT_URL",
"url": "<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({
message: {subject: '<string>', body: JSON.stringify('<string>')},
dueDate: '2023-11-07T05:31:56Z',
applicationId: '<string>',
type: 'VISIT_URL',
url: '<string>'
})
};
fetch('https://api.gospott.com/candidates/{id}/todos', 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/candidates/{id}/todos",
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([
'message' => [
'subject' => '<string>',
'body' => '<string>'
],
'dueDate' => '2023-11-07T05:31:56Z',
'applicationId' => '<string>',
'type' => 'VISIT_URL',
'url' => '<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/candidates/{id}/todos"
payload := strings.NewReader("{\n \"message\": {\n \"subject\": \"<string>\",\n \"body\": \"<string>\"\n },\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"applicationId\": \"<string>\",\n \"type\": \"VISIT_URL\",\n \"url\": \"<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/candidates/{id}/todos")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"message\": {\n \"subject\": \"<string>\",\n \"body\": \"<string>\"\n },\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"applicationId\": \"<string>\",\n \"type\": \"VISIT_URL\",\n \"url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/candidates/{id}/todos")
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 \"message\": {\n \"subject\": \"<string>\",\n \"body\": \"<string>\"\n },\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"applicationId\": \"<string>\",\n \"type\": \"VISIT_URL\",\n \"url\": \"<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>"
}Candidate Portal
Create a candidate to-do
Creates a new candidate to-do. Assigns a to-do to the candidate. A to-do of type VISIT_URL carries the link the candidate must open and requires url; a to-do of type UPLOAD_ATTACHMENT asks the candidate for a document and requires attachmentType. Documents themselves are not exchanged through this API.
POST
/
candidates
/
{id}
/
todos
Create a candidate to-do
curl --request POST \
--url https://api.gospott.com/candidates/{id}/todos \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"message": {
"subject": "<string>",
"body": "<string>"
},
"dueDate": "2023-11-07T05:31:56Z",
"applicationId": "<string>",
"type": "VISIT_URL",
"url": "<string>"
}
'import requests
url = "https://api.gospott.com/candidates/{id}/todos"
payload = {
"message": {
"subject": "<string>",
"body": "<string>"
},
"dueDate": "2023-11-07T05:31:56Z",
"applicationId": "<string>",
"type": "VISIT_URL",
"url": "<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({
message: {subject: '<string>', body: JSON.stringify('<string>')},
dueDate: '2023-11-07T05:31:56Z',
applicationId: '<string>',
type: 'VISIT_URL',
url: '<string>'
})
};
fetch('https://api.gospott.com/candidates/{id}/todos', 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/candidates/{id}/todos",
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([
'message' => [
'subject' => '<string>',
'body' => '<string>'
],
'dueDate' => '2023-11-07T05:31:56Z',
'applicationId' => '<string>',
'type' => 'VISIT_URL',
'url' => '<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/candidates/{id}/todos"
payload := strings.NewReader("{\n \"message\": {\n \"subject\": \"<string>\",\n \"body\": \"<string>\"\n },\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"applicationId\": \"<string>\",\n \"type\": \"VISIT_URL\",\n \"url\": \"<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/candidates/{id}/todos")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"message\": {\n \"subject\": \"<string>\",\n \"body\": \"<string>\"\n },\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"applicationId\": \"<string>\",\n \"type\": \"VISIT_URL\",\n \"url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/candidates/{id}/todos")
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 \"message\": {\n \"subject\": \"<string>\",\n \"body\": \"<string>\"\n },\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"applicationId\": \"<string>\",\n \"type\": \"VISIT_URL\",\n \"url\": \"<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.
Path Parameters
Body
application/json
- Option 1
- Option 2
Subject and body describing the to-do.
Show child attributes
Show child attributes
ISO 8601 timestamp by which the candidate should have completed the to-do.
Pattern:
^(?:(?:\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))$Id of the application this to-do relates to. Must be an application of the same candidate.
Minimum string length:
1Points the candidate to a link.
Available options:
VISIT_URL Link the candidate must open.
Maximum string length:
2048Response
The to-do was created. Returns its id.
Minimum string length:
1Was this page helpful?