Update a task
Update a task. Only the fields you send are changed.
assigned_to, date and is_complete can be updated on every type of task. The other fields only apply to some types, as their descriptions say. Sending text, priority, lead_id or contact_id for a type that doesn’t support it returns 400. The other fields are ignored.
Returns 403 if the task is on a lead you can’t see, or if it’s assigned to someone else and you don’t have the permission to manage other users’ tasks.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
ID of the task, e.g. task_aRUZXCm9lMb2LwipTPhfFoFbCsUnaoQh1ncQ7WLnjlI.
Query parameters
Comma-separated list of fields to include in the response.
Request
ID of the voice agent to make the call, instead of a user. Only applies to outgoing_call tasks, and can’t be set together with assigned_to. To remove the voice agent, set this to null and set assigned_to.
ID of the user to assign the task to. For an incomplete lead task, Close emails the new assignee, unless that’s you. On an outgoing_call task, this also removes the voice agent (agent_config_id).
ID of a contact on the task’s lead. Only lead and outgoing_call tasks have a contact. Set to null to remove it.
When the task is due, in ISO 8601. A date, e.g. 2024-01-31, makes the task due that day. A date and time, e.g. 2024-01-31T09:00:00Z, makes it due at that time.
true to complete the task, false to reopen it.
true if the task has no due date. Only applies to lead tasks, and is ignored on other types.
ID of the lead to link the task to. Only missed_call, incoming_sms, voicemail and answered_detached_call tasks can change their lead. This also moves the related call or message to the lead.
Priority of the task. Only lead and outgoing_call tasks have a priority.
How the task was closed without being done. Only applies to outgoing_call, draft_email and draft_sms tasks, and is ignored on other types. Set to null to clear it.
Description of the task. Only lead and outgoing_call tasks have text, and it can’t be blank on lead tasks.
Deprecated: use date instead.