v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB

Team Management

Create Custom Role

Creates a custom role with a per-category permission matrix. Custom roles are available on the Enterprise plan. Every category is at least 'view' — omitted categories default to 'view'. The role name must be unique in your organization and must not collide with a system role name; the permission matrix must not duplicate an existing role's. Requires a global API key.

post/api/v1/roles

Request body

namestring required

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

Example request

{
  "name": "Content Manager"
}

Response

Role created successfully

successboolean required

Example response

{
  "success": true,
  "role": {
    "name": "Content Manager",
    "slug": "content-manager"
  }
}