Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-056136556.2 KB
TaskrouterV1Task

post/v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}

Path parameters

WorkspaceSidstring required

The SID of the Workspace with the Task to update.

Sidstring required

The SID of the Task resource to update.

Headers

If-Matchstring

If provided, applies this mutation if (and only if) the ETag header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP If-Match header.

Response

OK

account_sidstring nullable

The SID of the Account that created the Task resource.

ageinteger

The number of seconds since the Task was created.

assignment_status'pending' | 'reserved' | 'assigned' | 'canceled' | 'completed' | 'wrapping'

The current status of the Task's assignment. Can be: pending, reserved, assigned, canceled, wrapping, or completed.

attributesstring nullable

The JSON string with custom attributes of the work. Note If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null.

addonsstring nullable

An object that contains the Add-on data for all installed Add-ons.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

task_queue_entered_datestring date-time nullable

The date and time in GMT when the Task entered the TaskQueue, specified in ISO 8601 format.

priorityinteger

The current priority score of the Task as assigned to a Worker by the workflow. Tasks with higher priority values will be assigned before Tasks with lower values.

reasonstring nullable

The reason the Task was canceled or completed, if applicable.

sidstring nullable

The unique string that we created to identify the Task resource.

task_queue_sidstring nullable

The SID of the TaskQueue.

task_queue_friendly_namestring nullable

The friendly name of the TaskQueue.

task_channel_sidstring nullable

The SID of the TaskChannel.

task_channel_unique_namestring nullable

The unique name of the TaskChannel.

timeoutinteger

The amount of time in seconds that the Task can live before being assigned.

workflow_sidstring nullable

The SID of the Workflow that is controlling the Task.

workflow_friendly_namestring nullable

The friendly name of the Workflow that is controlling the Task.

workspace_sidstring nullable

The SID of the Workspace that contains the Task.

urlstring uri nullable

The absolute URL of the Task resource.

linksobject nullable

The URLs of related resources.

virtual_start_timestring date-time nullable

The date and time in GMT indicating the ordering for routing of the Task specified in ISO 8601 format.

ignore_capacityboolean nullable

A boolean that indicates if the Task should respect a Worker's capacity and availability during assignment. This field can only be used when the RoutingTarget field is set to a Worker SID. By setting IgnoreCapacity to a value of true, 1, or yes, the Task will be routed to the Worker without respecting their capacity and availability. Any other value will enforce the Worker's capacity and availability. The default value of IgnoreCapacity is true when the RoutingTarget is set to a Worker SID.

routing_targetstring nullable

A SID of a Worker, Queue, or Workflow to route a Task to