Path parameters
-
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
, oryes
specifies the Activity is available. All other values specify that it is not. The value cannot be changed after the Activity is created. -
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
, andemail
.
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": "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"
}