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

Update Access Role

PATCH

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

permissions

Updates a specific access role by ID within the specified organization.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
  "id": "access_role_uuid_string",
  "name": "Senior Manager",
  "permissions": [
    "SHIFT_READ",
    "SHIFT_WRITE",
    "LOCATION_READ"
  ]
}

Request

Path Params

organization_id

string

required

The ID of the organization.

Example:

organization_uuid_string

string

required

The ID of the access role to update.

Example:

access_role_uuid_string

Body Params application/json

name

string

optional

permissions

array[string]

optional

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

🟢200OK

application/json

Successfully updated access role.

Body

object {0}

Get Access Role

Delete Access Role