Create task

POST /v1/Workspaces/{WorkspaceSid}/Tasks

TODO: Resource-level docs

Path parameters

WorkspaceSid string Required

The SID of the Workspace that the new Task belongs to.

Body

Attributes string

A URL-encoded JSON string with the attributes of the new task. This value is passed to the Workflow's assignment_callback_url when the Task is assigned to a Worker. For example: { "task_type": "call", "twilio_call_sid": "CAxxx", "customer_ticket_number": "12345" }.
Priority integer

The priority to assign the new task and override the default. When supplied, the new Task will have this priority unless it matches a Workflow Target with a Priority set. When not supplied, the new Task will have the priority of the matching Workflow Target. Value can be 0 to 2^{31^} (2,147,483,647).
TaskChannel string

When MultiTasking is enabled, specify the TaskChannel by passing either its unique_name or sid. Default value is default.
Timeout integer

The amount of time in seconds the new task can live before being assigned. Can be up to a maximum of 2 weeks (1,209,600 seconds). The default value is 24 hours (86,400 seconds). On timeout, the task.canceled event will fire with description Task TTL Exceeded.
WorkflowSid string

The SID of the Workflow that you would like to handle routing for the new Task. If there is only one Workflow defined for the Workspace that you are posting the new task to, this parameter is optional.

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

Responses

201

Created
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

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

Request example

{
  "Attributes": "string",
  "Priority": 42,
  "TaskChannel": "string",
  "Timeout": 42,
  "WorkflowSid": "string"
}

Request examples

{
  "Attributes": "string",
  "Priority": 42,
  "TaskChannel": "string",
  "Timeout": 42,
  "WorkflowSid": "string"
}

Response examples (201)

{
  "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 (201)

{
  "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"
}