Create role

POST /v2/Services/{ServiceSid}/Roles

Account sid auth token

Roles determining user or member permissions

Path parameters

ServiceSid string Required

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

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

application/x-www-form-urlencoded

Body

FriendlyName string Required

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

The type of role. Can be: channel for Channel roles or deployment for Service roles.

Values are channel or deployment.
Permission array[string] 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.

Responses

201 application/json

Created
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- sid string | null
  
  The unique string that we created to identify the Role resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.
- account_sid string | null
  
  The SID of the Account that created the Role resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- service_sid string | null
  
  The SID of the Service the Role resource is associated with.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.
- friendly_name string | null
  
  The string that you assigned to describe the resource.
- type string
  
  The type of role. Can be: channel for Channel roles or deployment for Service roles.
  
  Values are channel or deployment.
- permissions array[string] | null
  
  An array of the permissions the role has been granted.
- date_created string(date-time) | null
  
  The date and time in GMT when the resource was created specified in ISO 8601 format.
- date_updated string(date-time) | null
  
  The date and time in GMT when the resource was last updated specified in ISO 8601 format.
- url string(uri) | null
  
  The absolute URL of the Role resource.

POST /v2/Services/{ServiceSid}/Roles

curl \
 --request POST 'https://chat.twilio.com/v2/Services/{ServiceSid}/Roles' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Type=channel&Permission=sendMessage&FriendlyName=friendly_name'

Request example

{"Type"=>"channel", "Permission"=>"sendMessage", "FriendlyName"=>"friendly_name"}

Response examples (201)

{
  "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "type": "channel",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "permissions": [
    "sendMessage",
    "leaveChannel",
    "editOwnMessage",
    "deleteOwnMessage"
  ],
  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2016-03-03T19:47:15Z",
  "date_updated": "2016-03-03T19:47:15Z",
  "friendly_name": "channel user"
}