Create task queue

POST /v1/Workspaces/{WorkspaceSid}/TaskQueues

TODO: Resource-level docs

Path parameters

  • WorkspaceSid string Required

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

Body

  • AssignmentActivitySid string

    The SID of the Activity to assign Workers when a task is assigned to them.

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

  • FriendlyName string Required

    A descriptive string that you create to describe the TaskQueue. For example Support-Tier 1, Sales, or Escalation.

  • MaxReservedWorkers integer

    The maximum number of Workers to reserve for the assignment of a Task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.

  • ReservationActivitySid string

    The SID of the Activity to assign Workers when a task is reserved for them.

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

  • TargetWorkers string

    A string that describes the Worker selection criteria for any Tasks that enter the TaskQueue. For example, '"language" == "spanish"'. The default value is 1==1. If this value is empty, Tasks will wait in the TaskQueue until they are deleted or moved to another TaskQueue. For more information about Worker selection, see Describing Worker selection criteria.

  • TaskOrder string

    How Tasks will be assigned to Workers. Set this parameter to LIFO to assign most recently created Task first or FIFO to assign the oldest Task first. Default is FIFO. Click here to learn more.

    Values are FIFO or LIFO.

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

    • assignment_activity_name string | null

      The name of the Activity to assign Workers when a task is assigned for them

    • assignment_activity_sid string | null

      The SID of the Activity to assign Workers when a task is assigned for them

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

    • date_created string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was last updated

    • friendly_name string | null

      The string that you assigned to describe the resource

    • links object(uri-map) | null

      The URLs of related resources

    • max_reserved_workers integer | null

      The maximum number of Workers to reserve

    • reservation_activity_name string | null

      The name of the Activity to assign Workers once a task is reserved for them

    • reservation_activity_sid string | null

      The SID of the Activity to assign Workers once a task is reserved for them

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

    • sid string | null

      The unique string that identifies the resource

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

    • target_workers string | null

      A string describing the Worker selection criteria for any Tasks that enter the TaskQueue

    • task_order string | null

      How Tasks will be assigned to Workers

      Values are FIFO or LIFO.

    • url string(uri) | null

      The absolute URL of the TaskQueue resource

    • workspace_sid string | null

      The SID of the Workspace that contains the TaskQueue

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.
POST /v1/Workspaces/{WorkspaceSid}/TaskQueues 
curl \
 -X POST https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/TaskQueues \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'AssignmentActivitySid=string&FriendlyName=string&MaxReservedWorkers=42&ReservationActivitySid=string&TargetWorkers=string&TaskOrder=FIFO'
Request example 
{
  "AssignmentActivitySid": "string",
  "FriendlyName": "string",
  "MaxReservedWorkers": 42,
  "ReservationActivitySid": "string",
  "TargetWorkers": "string",
  "TaskOrder": "FIFO"
}
Request examples 
{
  "AssignmentActivitySid": "string",
  "FriendlyName": "string",
  "MaxReservedWorkers": 42,
  "ReservationActivitySid": "string",
  "TargetWorkers": "string",
  "TaskOrder": "FIFO"
}
Response examples (201) 
{
  "account_sid": "string",
  "assignment_activity_name": "string",
  "assignment_activity_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "links": {},
  "max_reserved_workers": 42,
  "reservation_activity_name": "string",
  "reservation_activity_sid": "string",
  "sid": "string",
  "target_workers": "string",
  "task_order": "FIFO",
  "url": "https://example.com",
  "workspace_sid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "assignment_activity_name": "string",
  "assignment_activity_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "links": {},
  "max_reserved_workers": 42,
  "reservation_activity_name": "string",
  "reservation_activity_sid": "string",
  "sid": "string",
  "target_workers": "string",
  "task_order": "FIFO",
  "url": "https://example.com",
  "workspace_sid": "string"
}