TWtwilio
TaskrouterV1Worker

Changed on
post/v1/Workspaces/{WorkspaceSid}/Workers/{Sid}

Request

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

Path parameters

WorkspaceSidstring required

The SID of the Workspace with the Worker to update.

Sidstring required

The SID of the Worker resource to update.

Headers

If-Matchstring

The If-Match HTTP request header

Request body application/x-www-form-urlencoded

ActivitySidstring

The SID of a valid Activity that will describe the Worker's initial state. See Activities for more information.

Attributesstring

The JSON string that describes the Worker. For example: { "email": "Bob@example.com", "phone": "+5095551234" }. This data is passed to the assignment_callback_url when TaskRouter assigns a Task to the Worker. Defaults to {}.

FriendlyNamestring

A descriptive string that you create to describe the Worker. It can be up to 64 characters long.

RejectPendingReservationsboolean

Whether to reject the Worker's pending reservations. This option is only valid if the Worker's new Activity resource has its availability property set to False.

Response

OK

account_sidstring nullable

The SID of the Account that created the Worker resource.

activity_namestring nullable

The friendly_name of the Worker's current Activity.

activity_sidstring nullable

The SID of the Worker's current Activity.

attributesstring nullable

The JSON string that describes the Worker. For example: { "email": "Bob@example.com", "phone": "+5095551234" }. Note If this property has been assigned a value, it will only be displayed in FETCH actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the assignment_callback_url when TaskRouter assigns a Task to the Worker.

availableboolean nullable

Whether the Worker is available to perform tasks.

date_createdstring date-time nullable

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

date_status_changedstring date-time nullable

The date and time in GMT of the last change to the Worker's activity specified in ISO 8601 format. Used to calculate Workflow statistics.

date_updatedstring date-time nullable

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

friendly_namestring nullable

The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace.

sidstring nullable

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

workspace_sidstring nullable

The SID of the Workspace that contains the Worker.

urlstring uri nullable

The absolute URL of the Worker resource.

linksobject nullable

The URLs of related resources.

Changes