Create worker

POST /v1/Workspaces/{WorkspaceSid}/Workers

TODO: Resource-level docs

Path parameters

  • WorkspaceSid string Required

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

Body

  • ActivitySid string

    The SID of a valid Activity that will describe the new Worker's initial state. See Activities for more information. If not provided, the new Worker's initial state is the default_activity_sid configured on the Workspace.

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

  • Attributes string

    A valid JSON string that describes the new Worker. For example: { "email": "Bob@example.com", "phone": "+5095551234" }. This data is passed to the assignment_callback_url when TaskRouter assigns a Task to the Worker. Defaults to {}.

  • FriendlyName string Required

    A descriptive string that you create to describe the new Worker. It can be up to 64 characters long.

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

    • activity_name string | null

      The friendly_name of the Worker's current Activity

    • activity_sid string | null

      The SID of the Worker's current Activity

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

    • attributes string | null

      The JSON string that describes the Worker

    • available boolean | null

      Whether the Worker is available to perform tasks

    • date_created string(date-time) | null

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

    • date_status_changed string(date-time) | null

      The date and time in GMT of the last change to the Worker's activity

    • date_updated string(date-time) | null

      The ISO 8601 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

    • sid string | null

      The unique string that identifies the resource

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

    • url string(uri) | null

      The absolute URL of the Worker resource

    • workspace_sid string | null

      The SID of the Workspace that contains the Worker

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.
POST /v1/Workspaces/{WorkspaceSid}/Workers 
curl \
 -X POST https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workers \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'ActivitySid=string&Attributes=string&FriendlyName=string'
Request example 
{
  "ActivitySid": "string",
  "Attributes": "string",
  "FriendlyName": "string"
}
Request examples 
{
  "ActivitySid": "string",
  "Attributes": "string",
  "FriendlyName": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "activity_name": "string",
  "activity_sid": "string",
  "attributes": "string",
  "available": true,
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_status_changed": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "links": {},
  "sid": "string",
  "url": "https://example.com",
  "workspace_sid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "activity_name": "string",
  "activity_sid": "string",
  "attributes": "string",
  "available": true,
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_status_changed": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "links": {},
  "sid": "string",
  "url": "https://example.com",
  "workspace_sid": "string"
}