This page documents the canonical HTTP contract for this endpoint.
Changing status to completed, skipped, or failed runs task-completion behavior, which can advance a linked sequence and return follow-up fields such as next_task or action_required. Status updates are state-changing operations.
Path parameters
task_idrequiredstring
Task ID.
| Name | Type | Description |
|---|---|---|
| task_idrequired | string | Task ID. |
Query parameters
actorUserId· optionalstring
Optional actor override.
| Name | Type | Description |
|---|---|---|
| actorUserId | string | Optional actor override. |
Body parameters
task_status· optionalstring
pending, scheduled, paused, completed, failed, or skipped.
priority· optionalstring
low, medium, or high.
due_date· optionalstring (ISO datetime)
Task due date.
content· optionalobject
Updated channel content payload.
notes· optionalstring
Optional task notes.
instructions· optionalstring
Optional task instructions.
started_at· optionalstring (ISO datetime)
Start timestamp.
completed_at· optionalstring (ISO datetime)
Completion timestamp.
attempt_count· optionalinteger
Attempt counter.
last_outcome· optionalstring
Last task outcome.
task_group_id· optionalstring
Task group ID; null clears it.
origin· optionalstring
sequence, manual, or system.
sender_bindings· optionalobject
Channel-keyed sender binding values.
sender_account_id· optionalstring
Sender account override, subject to actor access and sender identity lock.
sender_user_id· optionalstring
Sender owner override.
senderBindings· optionalobject
Camel-case alias for sender_bindings.
senderAccountId· optionalstring
Camel-case alias for sender_account_id.
senderUserId· optionalstring
Camel-case alias for sender_user_id.
email_type· optionalstring
personal or bulk.
email_provider· optionalstring
gmail, microsoft, instantly, smartlead, or internal.
provider_account_email· optionalstring
Sender mailbox address.
campaign_id· optionalstring
Provider campaign ID.
campaign_step· optionalinteger
Provider campaign step.
related_activity_id· optionalstring
Related activity ID.
sequence_execution_mode· optionalstring
Sequence execution mode.
sequence_blocks· optionalboolean
Sequence blocking flag.
subject· optionalstring
Email subject field used by approval flows.
body· optionalstring
Email body field used by approval flows.
body_format· optionalstring
Email body format.
draft_feedback· optionalobject
Optional feedback captured when completing an AI-drafted task.
| Name | Type | Description |
|---|---|---|
| task_status | string | pending, scheduled, paused, completed, failed, or skipped. |
| priority | string | low, medium, or high. |
| due_date | string (ISO datetime) | Task due date. |
| content | object | Updated channel content payload. |
| notes | string | Optional task notes. |
| instructions | string | Optional task instructions. |
| started_at | string (ISO datetime) | Start timestamp. |
| completed_at | string (ISO datetime) | Completion timestamp. |
| attempt_count | integer | Attempt counter. |
| last_outcome | string | Last task outcome. |
| task_group_id | string | Task group ID; null clears it. |
| origin | string | sequence, manual, or system. |
| sender_bindings | object | Channel-keyed sender binding values. |
| sender_account_id | string | Sender account override, subject to actor access and sender identity lock. |
| sender_user_id | string | Sender owner override. |
| senderBindings | object | Camel-case alias for sender_bindings. |
| senderAccountId | string | Camel-case alias for sender_account_id. |
| senderUserId | string | Camel-case alias for sender_user_id. |
| email_type | string | personal or bulk. |
| email_provider | string | gmail, microsoft, instantly, smartlead, or internal. |
| provider_account_email | string | Sender mailbox address. |
| campaign_id | string | Provider campaign ID. |
| campaign_step | integer | Provider campaign step. |
| related_activity_id | string | Related activity ID. |
| sequence_execution_mode | string | Sequence execution mode. |
| sequence_blocks | boolean | Sequence blocking flag. |
| subject | string | Email subject field used by approval flows. |
| body | string | Email body field used by approval flows. |
| body_format | string | Email body format. |
| draft_feedback | object | Optional feedback captured when completing an AI-drafted task. |
Errors
| Status | Meaning |
|---|---|
| 400 | Invalid payload or actor. |
| 401 | Invalid API key or missing auth. |
| 403 | Missing tasks:write scope. |
| 404 | Task not found. |
