Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Permissions

Update Role

Updates an existing permissions role's name and action set.

The update is a full replacement of the role definition.

🚧 Built-in system roles (such as Admin and Member) cannot be updated. Attempting to modify a system role returns an error.

put/api/permissions/roles/{id}

Path parameters

idstring uuid required
Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Request body

namestring required
organization_idstring uuid nullable

Example request

{
  "name": "Custom",
  "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
}

Response

OK

Example response

{
  "data": {
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "name": "Custom",
    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
  }
}