Skip to main content
POST
Create an offboarding confirmation intent
Key: Write Scope: Company

Authorizations

Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Body

application/json
offboardingId
string
required

The offboarding this step belongs to, from getOffboardings

Pattern: ^[a-f\d]{24}$
lastDay
string<date-time> | null

The leaver's last day. Defaults to the offboarding's termination date.

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))$
contactEmail
string<email> | null

An address of the leaver to reach them after they leave; must be one of their emails. Null clears it.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phone
string | null

The leaver's phone. Defaults to the one on the employee.

Minimum string length: 1
parentTicketId
string | null

The ticket to hold the task. Defaults to the offboarding ticket; never a typed task.

Pattern: ^[a-f\d]{24}$

Response

default - application/json
id
string
required

Intent id, to pass to its update and execute tools

taskId
string | null
required

The typed task that tracks this step

ticketId
string | null
required

The ticket holding that task, usually the offboarding ticket. Null if it could not be read back.

offboardingId
string
required
executedAt
string<date-time> | null
required

When the intent executed; null until then

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))$
lastDay
string<date-time> | null
required
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))$
contactEmail
string | null
required
phone
string | null
required