Skip to main content
POST
Create Custom Role

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Body

application/json

Request body for creating a custom role

name
string
required

Display name of the role. Must be unique in your organization (case-insensitive) and must not collide with a system role name.

Example:

"Content Manager"

permissions
object
required

Per-category access levels for a role. Every category is at least 'view'; categories omitted on create/update default to 'view'.

Response

Role created successfully

success
boolean
required
Example:

true

role
object
required

A role available in your organization — a built-in system role or a custom role.