Create task

POST /v1/Workspaces/{WorkspaceSid}/Tasks

Account sid auth token

Path parameters

WorkspaceSid string Required

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

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

application/x-www-form-urlencoded

Body

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.
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.
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}$.
Attributes string

A 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" }.
VirtualStartTime string(date-time)

The virtual start time to assign the new task and override the default. When supplied, the new task will have this virtual start time. When not supplied, the new task will have the virtual start time equal to date_created. Value can't be in the future or before the year of 1900.
RoutingTarget string

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

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.
TaskQueueSid string

The SID of the TaskQueue in which the Task belongs

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

Responses

201 application/json

Created
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

POST /v1/Workspaces/{WorkspaceSid}/Tasks

curl \
 --request POST 'https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Tasks' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Timeout=1&Priority=1&Attributes=%7B%22body%22%3A+%22attributes%22%7D&TaskChannel=channel&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&RoutingTarget=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IgnoreCapacity=false&VirtualStartTime=2014-05-14T18%3A50%3A02Z&RequiredAttention=0'

Request example

{"Timeout"=>1, "Priority"=>1, "Attributes"=>"{\"body\": \"attributes\"}", "TaskChannel"=>"channel", "WorkflowSid"=>"WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "TaskQueueSid"=>"WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "RoutingTarget"=>"WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "IgnoreCapacity"=>"false", "VirtualStartTime"=>"2014-05-14T18:50:02Z", "RequiredAttention"=>0}

Response examples (201)

{
  "age": 25200,
  "sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "workflow": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "task_queue": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations"
  },
  "addons": "{}",
  "reason": "Test Reason",
  "timeout": 60,
  "priority": 1,
  "attributes": "{\"body\": \"attributes\"}",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2014-05-14T18:50:02Z",
  "date_updated": "2014-05-15T07:26:06Z",
  "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "routing_target": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "ignore_capacity": false,
  "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "assignment_status": "pending",
  "required_attention": 0,
  "virtual_start_time": "2014-05-14T18:50:02Z",
  "workflow_friendly_name": "Example Workflow",
  "task_queue_entered_date": null,
  "task_channel_unique_name": "unique",
  "task_queue_friendly_name": "Example Task Queue"
}