/tasks/{taskId}/actions

Apply one lifecycle action to an open task. The body is discriminated on type.

complete closes the task. When the task carries a form, formOutput is validated against it; a validation failure leaves the task open and the 400 response reports per-element details in issues, each naming the element and the step it belongs to. Elements hidden by a visibleIf condition are not required and must be omitted; sending a value for one is rejected. Documents referenced by a file element must already exist, be linked to this task, and have finished uploading. Any http-json validators configured on the form run last, once every other check has passed; a rejection or an unreachable endpoint leaves the task open. Tasks marked as requiring a human reject completion through this endpoint. When the task was created from a template with a documentTemplateId, a PDF is rendered from that document template asynchronously after completion and linked to the task and its referenced entity; subscribe to the document-link-action-created webhook (filter targetEntityType: "task") or list the task's documents to pick it up. The render never delays or fails the completion.

skip closes a task that was created as skippable; otherwise the request is rejected with 412. cancel closes a task that is no longer needed, e.g. one created in error. Both are terminal; the task and its history stay readable.

reassign moves the open task to another organization, team, or user scope.

snooze hides the task from the calling API key's default listings until until (epoch seconds). Snoozes are per actor: nobody else's listing changes, the task stays open, and a snooze never outlives the task's due date, so snoozing an overdue task has no visible effect. Pass includeSnoozed=true when listing to see snoozed tasks anyway. unsnooze ends the caller's snooze early and is a no-op without one.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The task ID

Body Params
formOutput
object

The filled form, keyed by form element id. Required elements must be present; values are validated against the task's form definition and a failure leaves the task open, reporting per-element details that name both the element and its step. Elements hidden by a visibleIf condition are not required and must be omitted. A file element takes an array of ids of documents already created and linked to this task. Omit the whole field when the task carries no form.

string
enum
required

Complete the open task. When the task carries a form, formOutput is validated against it; a failure leaves the task open. Terminal. Repeating a completion that already landed, with the same formOutput, returns the completed task unchanged (200); a different formOutput on a completed task is a 409.

Allowed:
Responses

400

bad request - unknown action type, form output invalid, or a snooze end that is not in the future

401

unauthorized - missing or invalid credentials, or the caller lacks the TaskAction permission for this action type

403

forbidden - the task requires a human and the caller is not one

404

task not found

409

conflict - task is no longer open

412

precondition failed - task is not skippable

503

the request ran out of time while an external validator was still running; the task was not completed, send it again

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json