Skip to main content
POST
Create

Constraints

Authorizations

apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Body

application/json
role
string
default:""
required

A unique identifier for the role.

name
string
default:""
required

Friendly name of the role.

description
string
default:""

Description of the role.

metadata
object

Addition information about the role as JSON.

settings
object

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

Response

200 - application/json

Created a new Role

data
object