Update task status
Mark a task as COMPLETED or CANCELLED. A task that completes by executing its intent refuses COMPLETED with a 403 TaskLockedByTypeError whose message names the operation to call instead (executeEquipmentOrderIntent for an EQUIPMENT_ORDER task, executeEmployeeCreationIntent for an EMPLOYEE_CREATION task, executeEmailAccountIntent for an EMAIL_ACCOUNT task, executeSaasSelectionIntent for a SAAS_SELECTION task, executeEmailAccountSelectionIntent for an EMAIL_ACCOUNT_SELECTION task, executeOffboardingConfirmationIntent for an OFFBOARDING_CONFIRMATION task, executeDeviceHandlingIntent for a DEVICE_HANDLING task); CANCELLED stays open. The admin-managed steps of an onboarding ticket are refused too — an onboarding step closes by doing its work, not by marking its task done — and so is cancelling an automatic task of an onboarding ticket that carries no type. For the Equipment task of an onboarding, use executeOnboardingEquipment instead: it places the order or assigns stock and then closes both the step and this task. An agent may also cancel a task it scheduled with scheduleTask that has not woken yet (listed in sleepingReminders of getTicket); it cannot complete one. Provide the parent ticketId in the body.
Authorizations
Use your Primo API key in the Authorization header as Bearer <API_KEY>.
Path Parameters
Body
Response
PENDING, IN_PROGRESS, COMPLETED, CANCELLED, SCHEDULED, LOADING, SLEEPING LOW, MEDIUM, HIGH ^(?:(?:\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))$Wake-up date of a SCHEDULED (dormant) task; null on any other status
^(?:(?:\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))$Pick-up date of a SLEEPING task, which nobody sees until then; null on any other status
^(?:(?:\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))$Whether a human (not only the system) may complete this task
Whether only an admin may assign this task or change its status
- Option 1
- Option 2
- Option 3
Ids of the tags attached to this task
Id of the AI agent handling it; null when no agent is on it
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
Id of a typed task's intent, to pass to its update and execute tools; null for a plain task