UpdateDepartmentRoleRequest

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

UpdateDepartmentRoleRequest

FieldTypeRequiredDescription
slugstringno

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]+)*$

namestringno

1–200 characters

descriptionstring | nullno

Send null or empty to clear the description.

at most 2000 characters

permissionsarray of stringno

Replaces the whole permission set, from the set the code understands. Duplicates are collapsed; an empty array grants nothing.

at most 34 items

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