v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01206322659.2 KB
iam

Partially update a custom organization role.

patch/orgs/{org_id}/iam/roles/{role_id}

Path parameters

org_idstring required
role_idstring required

Request body

descriptionstring nullable

Human-readable description. Pass null to clear.

namestring nullable

New role name. Reserved system names rejected.

Response

Role updated

created_atstring date-time required
descriptionstring nullable
idstring required
namestring required
source'system' | 'custom' required

Whether a role is a built-in preset or defined by the organization. system roles are read-only; custom roles can be edited or deleted by an organization admin.

updated_atstring date-time required