TaskrouterV1Workspace
post/v1/Workspaces/{Sid}

Request

  • Base URL
    https://taskrouter.twilio.com
  • URL
    https://taskrouter.twilio.com/v1/Workspaces/{Sid}
  • Auth
    HTTP basic

Path parameters

Sidstring required

The SID of the Workspace resource to update.

Request body application/x-www-form-urlencoded

DefaultActivitySidstring

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

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

EventsFilterstring

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.

FriendlyNamestring

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

MultiTaskEnabledboolean

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.

TimeoutActivitySidstring

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

PrioritizeQueueOrder'FIFO' | 'LIFO'

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.

Response

OK

account_sidstring nullable

The SID of the Account that created the Workspace resource.

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

default_activity_namestring nullable

The name of the default activity.

default_activity_sidstring nullable

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

event_callback_urlstring uri nullable

The URL we call when an event occurs. If provided, the Workspace will publish events to this URL, for example, to collect data for reporting. See Workspace Events for more information. This parameter supports Twilio's Webhooks (HTTP callbacks) Connection Overrides.

events_filterstring nullable

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.

friendly_namestring nullable

The string that you assigned to describe the Workspace resource. For example Customer Support or 2014 Election Campaign.

multi_task_enabledboolean nullable

Whether multi-tasking is enabled. The default is true, which enables multi-tasking. Multi-tasking allows Workers to handle multiple Tasks simultaneously. When enabled (true), each Worker can receive parallel reservations up to the per-channel maximums defined in the Workers section. In single-tasking each Worker would only receive a new reservation when the previous task is completed. Learn more at Multitasking.

sidstring nullable

The unique string that we created to identify the Workspace resource.

timeout_activity_namestring nullable

The name of the timeout activity.

timeout_activity_sidstring nullable

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

prioritize_queue_order'FIFO' | 'LIFO'

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.

urlstring uri nullable

The absolute URL of the Workspace resource.

linksobject nullable

The URLs of related resources.

Changes