Permissions

Rename a role

Changed on

Renames a team permission set (a custom role). Member and Admin permissions keep their names, and archived sets can't be changed. Requires permissions.manage (only the owner has it by default), a recent sign-in, and the Permissions and Shared roles features.

patch/v1/permissions/sets/{permissionSetId}

Request

  • Base URL: https://api.openworklabs.com
  • URL: https://api.openworklabs.com/v1/permissions/sets/{permissionSetId}
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

permissionSetIdstring typeid required

Den TypeID with 'pms_' prefix and a 26-character base32 suffix.

Request body

namestring required

The role's new name.

Response

Role renamed; its current state is returned.

Changes