Sign in
Permissions

Update a Role

This endpoint updates a role for the given organisation.

put/roles/{roleId}

Request body

namestring

Display name of the role, shown in the admin UI when managing user permissions. Pick a name that summarises the role's responsibilities (e.g. "Spa Manager"). 1-120 characters.

descriptionstring nullable

Free-text description of what the role is for, shown underneath the role name in the admin UI. Use it to record the scope and intent of the permission bundle. Plain text, up to 500 characters.

permissionsstring[] nullable

The permissions assigned to this role.

Example request

{
  "name": "Spa Manager",
  "description": "Allows access to settings for the assigned site.",
  "permissions": [
    "clients.view"
  ]
}

Response

The role was successfully retrieved.

Example response

{
  "data": {
    "name": "Spa Manager",
    "description": "Allows access to settings for the assigned site.",
    "permissions": [
      "clients.view"
    ]
  }
}

Changes