Headers

• If-Match string

  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.

Path parameters

• WorkspaceSid string Required

  The SID of the Workspace with the Task to update.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

• Sid string Required

  The SID of the Task resource to update.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WT[0-9a-fA-F]{32}$.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • ETag string
  • X-Rate-Limit-Limit string
  • X-Rate-Limit-Remaining string
  • X-Rate-Limit-Config string
  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • account_sid string | null

    The SID of the Account that created the Task resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • age integer

    The number of seconds since the Task was created.

    Default value is 0.

  • assignment_status string

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

    Values are pending, reserved, assigned, canceled, completed, or wrapping.

  • attributes string | null

    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.

  • addons string | null

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

  • date_created string(date-time) | null

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

  • date_updated string(date-time) | null

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

  • task_queue_entered_date string(date-time) | null

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

  • priority integer

    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.

    Default value is 0.

  • reason string | null

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

  • sid string | null

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WT[0-9a-fA-F]{32}$.

  • task_queue_sid string | null

    The SID of the TaskQueue.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WQ[0-9a-fA-F]{32}$.

  • task_queue_friendly_name string | null

    The friendly name of the TaskQueue.

  • task_channel_sid string | null

    The SID of the TaskChannel.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^TC[0-9a-fA-F]{32}$.

  • task_channel_unique_name string | null

    The unique name of the TaskChannel.

  • timeout integer

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

    Default value is 0.

  • workflow_sid string | null

    The SID of the Workflow that is controlling the Task.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WW[0-9a-fA-F]{32}$.

  • workflow_friendly_name string | null

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

  • workspace_sid string | null

    The SID of the Workspace that contains the Task.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

  • url string(uri) | null

    The absolute URL of the Task resource.

  • links object(uri-map) | null

    The URLs of related resources.

  • virtual_start_time string(date-time) | null

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

  • ignore_capacity boolean | null

    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_target string | null

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