Create role

POST /v1/Services/{ServiceSid}/Roles
Account sid auth token

Path parameters

  • ServiceSid string Required

    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
  • Type string Required

    Values are channel or deployment.

  • Permission array[string] Required

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

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

    • account_sid string | null

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

    • service_sid string | null

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

    • friendly_name string | null
    • type string

      Values are channel or deployment.

    • permissions array[string] | null
    • date_created string(date-time) | null
    • date_updated string(date-time) | null
    • url string(uri) | null
POST /v1/Services/{ServiceSid}/Roles 
curl \
 --request POST 'https://ip-messaging.twilio.com/v1/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://ip-messaging.twilio.com/v1/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"
}