latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Roles

Create a Role

Permissions needed: ACCESS_ADMINISTRATION_SETTINGS Store Role for a clinic

post/api/v1/roles

Request body

titlestring

clinic_idinteger

The clinic to create the role for. Required if group_id is not provided. Mutually exclusive with group_id.

group_idinteger

The enterprise group to create the role for. Required if clinic_id is not provided. Mutually exclusive with clinic_id. Requires enterprise admin permissions.

permissions_idsinteger[]

Example request

{
  "title": "Doctor",
  "clinic_id": 1
}

Response

successful operation

integer required

Role Id