Update Role | Polytomic Docs

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.

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

idstringRequiredformat: "uuid"

This endpoint expects an object.

namestringRequired

organization_idstring or nullOptionalformat: "uuid"

dataobject

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	curl -X PUT https://app.polytomic.com/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d \
2	-H "X-Polytomic-Version: X-Polytomic-Version" \
3	-H "Content-Type: application/json" \
4	-u "<username>:<password>" \
5	-d '{
6	"name": "Custom"
7	}'

1	{
2	"data": {
3	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
4	"name": "Custom",
5	"organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
6	"system": false
7	}
8	}