Update task

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

TODO: Resource-level docs

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.
Sid string Required

The SID of the Task resource to update.

Body

AssignmentStatus string

The new status of the task. Can be: canceled, to cancel a Task that is currently pending or reserved; wrapping, to move the Task to wrapup state; or completed, to move a Task to the completed state.

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

The JSON string that describes the custom attributes of the task.
Priority integer

The Task's new priority value. When supplied, the Task takes on the specified priority unless it matches a Workflow Target with a Priority set. Value can be 0 to 2^{31^} (2,147,483,647).
Reason string

The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.
TaskChannel string

When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its unique_name, such as voice, sms, or default.

Responses

200

OK
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account that created the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- addons string | null
  
  An object that contains the addon data for all installed addons
- age integer | null
  
  The number of seconds since the Task was created
- assignment_status string | null
  
  The current status of the Task's assignment
  
  Values are pending, reserved, assigned, canceled, completed, or wrapping.
- attributes string | null
  
  The JSON string with custom attributes of the work
- date_created string(date-time) | null
  
  The ISO 8601 date and time in GMT when the resource was created
- date_updated string(date-time) | null
  
  The ISO 8601 date and time in GMT when the resource was last updated
- links object(uri-map) | null
  
  The URLs of related resources
- priority integer | null
  
  Retrieve the list of all Tasks in the Workspace with the specified priority
- reason string | null
  
  The reason the Task was canceled or completed
- sid string | null
  
  The unique string that identifies the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WT[0-9a-fA-F]{32}$.
- 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
- task_queue_entered_date string(date-time) | null
  
  The ISO 8601 date and time in GMT when the Task entered the TaskQueue.
- task_queue_friendly_name string | null
  
  The friendly name of the TaskQueue
- 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}$.
- timeout integer | null
  
  The amount of time in seconds that the Task can live before being assigned
- url string(uri) | null
  
  The absolute URL of the Task resource
- workflow_friendly_name string | null
  
  The friendly name of the Workflow that is controlling the Task
- 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}$.
- 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}$.

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

curl \
 -X POST https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Tasks/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -H "If-Match: string" \
 -d 'AssignmentStatus=pending&Attributes=string&Priority=42&Reason=string&TaskChannel=string'

Request example

# Headers
If-Match: string

# Payload
{
  "AssignmentStatus": "pending",
  "Attributes": "string",
  "Priority": 42,
  "Reason": "string",
  "TaskChannel": "string"
}

Request examples

# Headers
If-Match: string

# Payload
{
  "AssignmentStatus": "pending",
  "Attributes": "string",
  "Priority": 42,
  "Reason": "string",
  "TaskChannel": "string"
}

Response examples (200)

{
  "account_sid": "string",
  "addons": "string",
  "age": 42,
  "assignment_status": "pending",
  "attributes": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "links": {},
  "priority": 42,
  "reason": "string",
  "sid": "string",
  "task_channel_sid": "string",
  "task_channel_unique_name": "string",
  "task_queue_entered_date": "2023-05-04T09:42:00+00:00",
  "task_queue_friendly_name": "string",
  "task_queue_sid": "string",
  "timeout": 42,
  "url": "https://example.com",
  "workflow_friendly_name": "string",
  "workflow_sid": "string",
  "workspace_sid": "string"
}

Response examples (200)

{
  "account_sid": "string",
  "addons": "string",
  "age": 42,
  "assignment_status": "pending",
  "attributes": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "links": {},
  "priority": 42,
  "reason": "string",
  "sid": "string",
  "task_channel_sid": "string",
  "task_channel_unique_name": "string",
  "task_queue_entered_date": "2024-05-04T09:42:00+00:00",
  "task_queue_friendly_name": "string",
  "task_queue_sid": "string",
  "timeout": 42,
  "url": "https://example.com",
  "workflow_friendly_name": "string",
  "workflow_sid": "string",
  "workspace_sid": "string"
}