Bulk-update tasks
Apply the same changes to every task that matches the filters, and return how many tasks were updated. Takes the same filters as GET /task/, as query params or in the _params body key. The other body fields are the changes to make, e.g.:
One call updates at most _limit tasks, and the response doesn’t say whether more tasks matched. Repeat the call to update the rest. Returns 400 if id__in lists 1000 or more IDs.
Returns 400 if some tasks couldn’t be updated, with count set to the number that were, and the reasons in errors. Also returns 400 if any of the tasks is 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.
Query parameters
Only return tasks assigned to this user, e.g. user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA. Returns 403 for another user if your role restricts which leads you can see.
Only return the task with this ID, e.g. task_aRUZXCm9lMb2LwipTPhfFoFbCsUnaoQh1ncQ7WLnjlI.
Comma-separated list of task IDs. Only return these tasks.
true to only return completed tasks, false to only return incomplete tasks.
Only return tasks on this lead, e.g. lead_5LmpOyrMQdJSUlbNGBSGfK5XzcioIm7aC94PSQamQJc.
Field to sort by: date, due_date, date_created or date_updated. Prefix with - to sort in descending order, e.g. -date. Defaults to -date_created.
Only return tasks of this type. Defaults to lead (tasks created on a lead) when neither _type nor _type__in is set. Use all to return every type.
Comma-separated list of task types, e.g. lead,outgoing_call. Only return tasks of any of these types. Takes the same values as _type, except all.
Shortcut for a task view. inbox returns incomplete tasks due by the end of today, future returns incomplete tasks due from tomorrow on, and archive returns completed tasks. Today is based on your time zone. inbox overrides is_complete and date__lt, future overrides is_complete and date__gte, and archive overrides is_complete.
Only return tasks due at exactly this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z. Values without a UTC offset are treated as UTC.
Only return tasks due before this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z. Values without a UTC offset are treated as UTC.
Only return tasks due on or before this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z. Values without a UTC offset are treated as UTC.
Only return tasks due after this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z. Values without a UTC offset are treated as UTC.
Only return tasks due on or after this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z. Values without a UTC offset are treated as UTC.
Deprecated: use date instead, which it matches.
Deprecated: use date__lt instead, which it matches.
Deprecated: use date__lte instead, which it matches.
Deprecated: use date__gt instead, which it matches.
Deprecated: use date__gte instead, which it matches.
Only return tasks created before this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks created on or before this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks created after this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks created on or after this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks last updated before this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks last updated on or before this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks last updated after this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks last updated on or after this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Request
Filters that select the tasks to update, as an alternative to query params. Takes the same filters as GET /task/, e.g. {"id__in": "task_A,task_B"}. Values must be strings or integers. Other values are ignored.
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).
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.
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.