CreateDepartmentRoleRequest

A request or response body; the type column links to the schemas it refers to.

CreateDepartmentRoleRequest

FieldTypeRequiredDescription
slugstringyes

Unique within the department. Slugs are lowercase letters and digits in words separated by single hyphens, like customer-success.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

namestringyes

1–200 characters

descriptionstringno

Omit or send empty for no description.

at most 2000 characters

permissionsarray of stringno

The permissions the role grants, from the set the code understands. Duplicates are collapsed; an empty array grants nothing.

at most 34 items · defaults to []

jsonExample
{
  "slug": "reviewer",
  "name": "Reviewer",
  "description": "string",
  "permissions": [
    "records:read",
    "records:write"
  ]
}