This page documents the canonical HTTP contract for this endpoint.
Path parameters
task_idrequiredstring
Email task identifier.
| Name | Type | Description |
|---|---|---|
| task_idrequired | string | Email task identifier. |
Query parameters
actorUserId· optionalstring
Optional active same-organization actor override.
| Name | Type | Description |
|---|---|---|
| actorUserId | string | Optional active same-organization actor override. |
Body parameters
send_atrequiredstring<date-time>
New scheduled send time.
provider· optionalstring
Optional email provider.
provider_account_email· optionalstring
Optional sender mailbox.
subject· optionalstring
Updated subject.
body_text· optionalstring
Updated plain-text content.
body_html· optionalstring
Updated HTML content.
body_format· optionalstring
auto (default) or explicit format.
thread_ref· optionalobject
Provider thread reference.
context_tags· optionalarray<object>
Context tags.
attachments· optionalarray<object>
Attachment descriptors.
| Name | Type | Description |
|---|---|---|
| send_atrequired | string<date-time> | New scheduled send time. |
| provider | string | Optional email provider. |
| provider_account_email | string | Optional sender mailbox. |
| subject | string | Updated subject. |
| body_text | string | Updated plain-text content. |
| body_html | string | Updated HTML content. |
| body_format | string | auto (default) or explicit format. |
| thread_ref | object | Provider thread reference. |
| context_tags | array<object> | Context tags. |
| attachments | array<object> | Attachment descriptors. |
Errors
| Status | Meaning |
|---|---|
| 401 | Authentication is missing or invalid. |
| 403 | Missing tasks:write. |
| 400 | Task ID format is invalid, task is not an email task, or task has no lead. |
| 404 | Task or associated lead not found. |
| 409 | Task requires action/review before scheduling. |
