Skip to content

Update users role

Request

🔒 Private label — contact sales. Requires a private-label entitlement on your API client.

Update users role

Security
oauth2ClientCredentials(Required scopes: roles:write)
Path
employee_idstringrequired
Headers
business_idstringrequired

Business identifier for the request

Bodyapplication/jsonrequired
rolestringrequired

User role

Enum:"CARD USER""APPROVER""ADMIN""REVIEWER""SUPER ADMIN""AUDITOR"
Example:"APPROVER"
curl -i -X PATCH \
  'https://developer.boyahq.com/_mock/v2/openapi/permissions/employees/{employee_id}/role' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'business_id: string' \
  -d '{
    "role": "APPROVER"
  }'

Responses

User role updated successfully

Bodyapplication/json
statusnumberrequired

HTTP status code

Example:200
dataobject(UpdateUsersRoleDataV1Dto)

Response data containing database name and permissions

timestampstringrequired

Response timestamp in ISO format

Example:"2026-01-09T08:18:46.794Z"
Response
{ "status": 200, "data": { "databaseName": "biz_4badab471100", "data": {} }, "timestamp": "2026-01-09T08:18:46.794Z" }