v12

latestOpenAPI 3.0.3raw.githubusercontent.com2026-06-1811583196.1 KB
Roles

Update custom role

Update a custom role's name, description, or permission set. System roles cannot be edited — return 400 Bad Request.

Editing a role applies to every member and API key currently using it.

patch/api/v1/roles/{id}

Path parameters

idstring uuid required

Role ID (UUID)

Request body

namestring
descriptionstring
permissionsstring[]

Response

Role updated

successboolean

Example response

{
  "data": {
    "name": "Operator",
    "slug": "operator"
  }
}