TWtwilio
ConversationsV1Role

Create a new user role in your service

Changed on

Create a new user role in your service

post/v1/Services/{ChatServiceSid}/Roles

Request

  • Base URL
    https://conversations.twilio.com
  • URL
    https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Roles
  • Auth
    HTTP basic

Path parameters

ChatServiceSidstring required

The SID of the Conversation Service to create the Role resource under.

Request body application/x-www-form-urlencoded

FriendlyNamestring required

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

Type'conversation' | 'service' required

The type of role. Can be: conversation for Conversation roles or service for Conversation Service roles.

Permissionstring[] required

A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's type.

Response

Created

sidstring nullable

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

account_sidstring nullable

The SID of the Account that created the Role resource.

chat_service_sidstring nullable

The SID of the Conversation Service the Role resource is associated with.

friendly_namestring nullable

The string that you assigned to describe the resource.

type'conversation' | 'service'

The type of role. Can be: conversation for Conversation roles or service for Conversation Service roles.

permissionsstring[] nullable

An array of the permissions the role has been granted.

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.

urlstring uri nullable

An absolute API resource URL for this user role.

Changes