Skip to main content
PUT
Update Role
Requires roles:manage. An API key needs the workspaces:write scope.
Same escalation guard as Create Role, but checked against the union of the role’s old and new permission sets: removing a permission you don’t hold from someone else’s role is also editing something that isn’t yours. Nobody — owner included in spirit, though the owner is exempt from the check — can edit the role currently assigned to themselves, and nobody can change their own role assignment through this endpoint.

Path

string
required
Workspace ID.
string
required
Role ID.

Body

Full replacement — same fields as Create Role, all required except the optional ones.
string
required
WorkspacePermission[]
required
number

Response

Same shape as Create Role.

Errors