Skip to main content
POST
Create a task
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
ticketId
string
required

Id of the parent ticket: the 24-character id returned by getTickets or getTicket, not the reference displayed in the product (e.g. IT-1741).

Pattern: ^[a-f\d]{24}$
title
string
required
Minimum string length: 1
description
string

What the task expects: when it is done and what to do when it is blocked. Shown to whoever opens it.

Minimum string length: 1
assigneeEmployeeId
string
priority
enum<string> | null
Available options:
LOW,
MEDIUM,
HIGH
dueDate
string<date-time> | null
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))$
tagIds
string[]

Ids of the tags to attach to the task

requester
object

Open the task on behalf of an employee or email. Defaults to the API key / connected user.

Response

default - application/json
id
string
required
ticketId
string
required
title
string
required
status
enum<string>
required
Available options:
PENDING,
IN_PROGRESS,
COMPLETED,
CANCELLED,
SCHEDULED,
LOADING,
SLEEPING
priority
enum<string> | null
required
Available options:
LOW,
MEDIUM,
HIGH
dueDate
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))$
scheduleDate
string<date-time> | null
required

Wake-up date of a SCHEDULED (dormant) task; null on any other status

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))$
wakeDate
string<date-time> | null
required

Pick-up date of a SLEEPING task, which nobody sees until then; null on any other status

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))$
isManuallyCompletable
boolean
required

Whether a human (not only the system) may complete this task

isAdminManaged
boolean
required

Whether only an admin may assign this task or change its status

assignee
object
required
tagIds
string[]
required

Ids of the tags attached to this task

aiAgentId
string | null
required

Id of the AI agent handling it; null when no agent is on it

type
string | null
required

Type of a typed task, which Primo runs through its intent (EMPLOYEE_CREATION, EMAIL_ACCOUNT, EMAIL_ACCOUNT_SELECTION, SAAS_SELECTION, SAAS_PROVISIONING, EQUIPMENT_ORDER, OFFBOARDING_CONFIRMATION, DEVICE_HANDLING); null for a plain task

intentId
string | null
required

Id of a typed task's intent, to pass to its update and execute tools; null for a plain task