TaskrouterWorkspace

Update Workspace

POST
/v1/Workspaces/{Sid}

Authorization

accountSid_authToken
AuthorizationBasic <token>

In: header

Path Parameters

Sid*string

The SID of the Workspace resource to update.

Match^WS[0-9a-fA-F]{32}$
Length34 <= length <= 34

Request Body

application/x-www-form-urlencoded

DefaultActivitySid?string

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

Match^WA[0-9a-fA-F]{32}$
Length34 <= length <= 34
EventCallbackUrl?string

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.

Formaturi
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.

TimeoutActivitySid?string

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

Match^WA[0-9a-fA-F]{32}$
Length34 <= length <= 34
PrioritizeQueueOrder?WorkspaceQueueOrder

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

Value in

  • "FIFO"
  • "LIFO"

Response Body

application/json

curl -X POST "https://example.com/v1/Workspaces/stringstringstringstringstringstri" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'DefaultActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventCallbackUrl=%2Fexample&FriendlyName=friendly_name&TimeoutActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DefaultAttentionProfileSid=WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
{  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "date_created": "2016-08-01T22:10:40Z",  "date_updated": "2016-08-01T22:10:40Z",  "default_activity_name": "Offline",  "default_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "event_callback_url": "",  "events_filter": null,  "friendly_name": "new",  "links": {    "activities": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities",    "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics",    "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics",    "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics",    "task_queues": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues",    "tasks": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks",    "workers": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers",    "workflows": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows",    "task_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels",    "events": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events"  },  "multi_task_enabled": false,  "prioritize_queue_order": "FIFO",  "sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "timeout_activity_name": "Offline",  "timeout_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}