Q2 2025 Roadmap: Request a beta API key and access upcoming features: Embedded Notifications, Team Communications and more.

Create Access Role

POST

/api/organizations/{organization_id}/access-roles

permissions

Creates a new access role within the specified organization.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/organizations/organization_uuid_string/access-roles' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Manager",
    "permissions": [
        "SHIFT_READ",
        "SHIFT_WRITE"
    ]
}'

Response Example

{
  "id": "access_role_uuid_string"
}

Request

Path Params

organization_id

string

required

The ID of the organization.

Example:

organization_uuid_string

Body Params application/json

name

string

required

permissions

array[string]

required

Allowed values:

SHIFT_READSHIFT_WRITESHIFT_ADDSHIFT_UPDATELOCATION_READLOCATION_ADMINORGANIZATION_ADMIN

Example:

["SHIFT_READ","SHIFT_WRITE","SHIFT_ADD","SHIFT_UPDATE","LOCATION_READ","LOCATION_ADMIN","ORGANIZATION_ADMIN"]

Examples

Responses

🟢201Created

application/json

Successfully created access role.

Body

object {0}

Exchange Token

List Access Roles