Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

Bearer authentication. Send Authorization: Bearer .

Path Parameters

id
string
required

Role ID

Body

application/json

Role Update Input

RoleUpdateInput payload

description
string

Role's description. Use a pointer to distinguish "not sent" (nil) from "clear it" (pointer to "").

Example:

"An updated description"

displayName
string

Role's display name.

Example:

"Updated Editor"

isEnabled
boolean

Whether the role is enabled.

Example:

true

Response

OK

RoleResponse payload

createdAt
string
Example:

"2026-06-24T10:00:00.000Z"

description
string
Example:

"A custom editor role"

groups
string[]
id
string
Example:

"custom-editor"

isEnabled
boolean
Example:

true

isSystem
boolean

Whether the role is a platform-managed system role, immutable through this API. Never omitempty: false must travel so a consumer does not read a missing key as "not a system role".

Example:

false

name
string
Example:

"Custom Editor"

roles
string[]
users
string[]