Sign in
Permissions

Create a Role

This endpoint creates a role for the given organisation.

post/roles

Request body

namestring required

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.

organisation_idstring uuid required

Identifier of the organisation that owns this role. Roles are scoped per organisation so each customer can define its own permission bundles; the role can be assigned to any user in the same organisation.

Example request

{
  "name": "Spa Manager"
}

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

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