Update workspace

POST /v1/Workspaces/{Sid}

TODO: Resource-level docs

Path parameters

Sid string Required

The SID of the Workspace resource to update.

Body

DefaultActivitySid string

The SID of the Activity that will be used when new Workers are created in the Workspace.

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

The URL we should call when an event occurs. See Workspace Events for more information. This parameter supports Twilio's Webhooks (HTTP callbacks) Connection Overrides.
EventsFilter string

The list of Workspace events for which to call event_callback_url. For example if EventsFilter=task.created,task.canceled,worker.activity.update, then TaskRouter will call event_callback_url only when a task is created, canceled, or a Worker activity is updated.
FriendlyName string

A descriptive string that you create to describe the Workspace resource. For example: Sales Call Center or Customer Support Team.
MultiTaskEnabled boolean

Whether to enable multi-tasking. Can be: true to enable multi-tasking, or false to disable it. However, all workspaces should be maintained as multi-tasking. There is no default when omitting this parameter. A multi-tasking Workspace can't be updated to single-tasking unless it is not a Flex Project and another (legacy) single-tasking Workspace exists. Multi-tasking allows Workers to handle multiple Tasks simultaneously. In multi-tasking mode, each Worker can receive parallel reservations up to the per-channel maximums defined in the Workers section. In single-tasking mode (legacy mode), each Worker will only receive a new reservation when the previous task is completed. Learn more at Multitasking.
PrioritizeQueueOrder string

The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: LIFO or FIFO. For more information, see Queue Ordering.

Values are FIFO or LIFO.
TimeoutActivitySid string

The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response.

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

Responses

200

OK
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}$.
- 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
- default_activity_name string | null
  
  The name of the default activity
- default_activity_sid string | null
  
  The SID of the Activity that will be used when new Workers are created in the Workspace
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WA[0-9a-fA-F]{32}$.
- event_callback_url string(uri) | null
  
  The URL we call when an event occurs
- events_filter string | null
  
  The list of Workspace events for which to call event_callback_url
- friendly_name string | null
  
  The string that you assigned to describe the Workspace resource
- links object(uri-map) | null
  
  The URLs of related resources
- multi_task_enabled boolean | null
  
  Whether multi-tasking is enabled
- prioritize_queue_order string | null
  
  The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues
  
  Values are FIFO or LIFO.
- sid string | null
  
  The unique string that identifies the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.
- timeout_activity_name string | null
  
  The name of the timeout activity
- timeout_activity_sid string | null
  
  The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response
  
  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 Workspace resource

POST /v1/Workspaces/{Sid}

curl \
 -X POST https://taskrouter.twilio.com/v1/Workspaces/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'DefaultActivitySid=string&EventCallbackUrl=https%3A%2F%2Fexample.com&EventsFilter=string&FriendlyName=string&MultiTaskEnabled=true&PrioritizeQueueOrder=FIFO&TimeoutActivitySid=string'

Request example

{
  "DefaultActivitySid": "string",
  "EventCallbackUrl": "https://example.com",
  "EventsFilter": "string",
  "FriendlyName": "string",
  "MultiTaskEnabled": true,
  "PrioritizeQueueOrder": "FIFO",
  "TimeoutActivitySid": "string"
}

Request examples

{
  "DefaultActivitySid": "string",
  "EventCallbackUrl": "https://example.com",
  "EventsFilter": "string",
  "FriendlyName": "string",
  "MultiTaskEnabled": true,
  "PrioritizeQueueOrder": "FIFO",
  "TimeoutActivitySid": "string"
}

Response examples (200)

{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "default_activity_name": "string",
  "default_activity_sid": "string",
  "event_callback_url": "https://example.com",
  "events_filter": "string",
  "friendly_name": "string",
  "links": {},
  "multi_task_enabled": true,
  "prioritize_queue_order": "FIFO",
  "sid": "string",
  "timeout_activity_name": "string",
  "timeout_activity_sid": "string",
  "url": "https://example.com"
}

Response examples (200)

{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "default_activity_name": "string",
  "default_activity_sid": "string",
  "event_callback_url": "https://example.com",
  "events_filter": "string",
  "friendly_name": "string",
  "links": {},
  "multi_task_enabled": true,
  "prioritize_queue_order": "FIFO",
  "sid": "string",
  "timeout_activity_name": "string",
  "timeout_activity_sid": "string",
  "url": "https://example.com"
}