Update an existing user role in your account's default service

POST /v1/Roles/{Sid}

A Role resource represents a set of permissions granted to a user within a service or a conversation.

Update an existing user role in your account's default service

Path parameters

  • Sid string Required

    The SID of the Role resource to update.

Body

  • Permission array[string] Required

    A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role's type.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

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

    • chat_service_sid string | null

      The SID of the Conversation Service that the resource is associated with

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

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • friendly_name string | null

      The string that you assigned to describe the resource

    • permissions array[string] | null

      An array of the permissions the role has been granted

    • sid string | null

      The unique string that identifies the resource

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

    • type string | null

      The type of role

      Values are conversation or service.

    • url string(uri) | null

      An absolute URL for this user role.
POST /v1/Roles/{Sid} 
curl \
 -X POST https://conversations.twilio.com/v1/Roles/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Permission=string'
Request example 
{
  "Permission": [
    "string"
  ]
}
Request examples 
{
  "Permission": [
    "string"
  ]
}
Response examples (200) 
{
  "account_sid": "string",
  "chat_service_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "permissions": [
    "string"
  ],
  "sid": "string",
  "type": "conversation",
  "url": "https://example.com"
}
Response examples (200) 
{
  "account_sid": "string",
  "chat_service_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "permissions": [
    "string"
  ],
  "sid": "string",
  "type": "conversation",
  "url": "https://example.com"
}