Admin > Roles

Update a role

Update a custom role in the Tines tenant.

put/api/v1/admin/roles/{id}

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v1/admin/roles/{id}
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Path parameters

idstring required

ID or name of the role

Request body

descriptionstring

Role description

permissionsstring[]

Permission names to apply to the role

Response

Successful response

idstring

Role ID

namestring

Role name

typestring

Role type, either custom or default

descriptionstring nullable

Role description

permissionsstring[]

Permission names applied to the role

created_atstring nullable

When the role was created. Null for default roles

updated_atstring nullable

When the role was last updated. Null for default roles

builderboolean

Whether the role grants builder / story editing permissions

Changes

No recorded changes to this operation across all 1 revision of this API.