Create activity

POST /v1/Workspaces/{WorkspaceSid}/Activities

TODO: Resource-level docs

Path parameters

WorkspaceSid string Required

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

Body

Available boolean

Whether the Worker should be eligible to receive a Task when it occupies the Activity. A value of true, 1, or yes specifies the Activity is available. All other values specify that it is not. The value cannot be changed after the Activity is created.
FriendlyName string Required

A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: on-call, break, and email.

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}$.
- available boolean | null
  
  Whether the Worker should be eligible to receive a Task when it occupies the Activity
- 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
- friendly_name string | null
  
  The string that you assigned to describe the Activity resource
- links object(uri-map) | null
- sid string | null
  
  The unique string that identifies the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WA[0-9a-fA-F]{32}$.
- url string(uri) | null
  
  The absolute URL of the Activity resource
- workspace_sid string | null
  
  The SID of the Workspace that contains the Activity
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

POST /v1/Workspaces/{WorkspaceSid}/Activities

curl \
 -X POST https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Activities \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Available=true&FriendlyName=string'

Request example

{
  "Available": true,
  "FriendlyName": "string"
}

Request examples

{
  "Available": true,
  "FriendlyName": "string"
}

Response examples (201)

{
  "account_sid": "string",
  "available": true,
  "date_created": "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",
  "available": true,
  "date_created": "2025-05-04T09:42:00Z",
  "date_updated": "2025-05-04T09:42:00Z",
  "friendly_name": "string",
  "links": {},
  "sid": "string",
  "url": "https://example.com",
  "workspace_sid": "string"
}