Update

Updates a given role.

Log in to see full request history

For a detailed description of the role properties please visit here

Request sample

PUT /roles/:role HTTP/1.1
Content-type: application/json
Accept: application/json

{
   "name": "string",
   "description": "string",
   "metadata": {
       "any key": "value pair",
   },
   "settings":{
       "listUsers": "string",
       "sendMessagesTo": "string"
   },
   "unset": ["array of strings"]
}
Path Params
string
required

A role to update.

Body Params
string

Friendly name of the role.

string

Description of the role.

metadata
object

Additional information about the role.

unset
array of strings
Defaults to

The unsettable role attributes are settings, description and metadata.

unset
settings
object

Role settings that is used for restricting list users/send message. Possible values for listUsers & sendMessagesTo are all and friendsOnly

Response

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json