Skip to main content
POST
Create a candidate to-do

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Path Parameters

id
string
required

Body

application/json
message
object | null
required

Subject and body describing the to-do.

dueDate
required

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))$
applicationId
string | null
required

Id of the application this to-do relates to. Must be an application of the same candidate.

Minimum string length: 1
type
enum<string>
required

Points the candidate to a link.

Available options:
VISIT_URL
url
string<uri>
required

Link the candidate must open.

Maximum string length: 2048

Response

The to-do was created. Returns its id.

id
string
required
Minimum string length: 1