Skip to content
Reference
/
/
Update role permissions

Update role permissions

Request

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

Update permissions for a specific role

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

Business identifier for the request

Bodyapplication/jsonrequired
permissionsobjectrequired

Role permissions object with permission keys and binary values (0=disabled, 1=enabled)

Example:
{
  "ALLOCATIONS_INITIATE": 1,
  "ALLOCATIONS_APPROVE": 0,
  "ALLOCATIONS_VIEW": 1,
  "BULK:PAYOUTS_INITIATE": 1,
  "BULK:PAYOUTS_APPROVE": 1,
  "BULK:PAYOUTS_VIEW": 1,
  "BUSINESS:STATEMENTS_VIEW": 1,
  "BUSINESS:BALANCE_VIEW": 1,
  "BUSINESS:BALANCE_EDIT": 1,
  "BUSINESS:SETTINGS_VIEW": 1,
  "BUSINESS:SETTINGS_EDIT": 1,
  "BUSINESS:TRENDS_VIEW": 1
}
curl -i -X PUT \
  'https://developer.boyahq.com/_mock/v2/openapi/permissions/update/{role_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'business_id: string' \
  -d '{
    "permissions": {
      "ALLOCATIONS_INITIATE": 1,
      "ALLOCATIONS_APPROVE": 0,
      "ALLOCATIONS_VIEW": 1,
      "BULK:PAYOUTS_INITIATE": 1,
      "BULK:PAYOUTS_APPROVE": 1,
      "BULK:PAYOUTS_VIEW": 1,
      "BUSINESS:STATEMENTS_VIEW": 1,
      "BUSINESS:BALANCE_VIEW": 1,
      "BUSINESS:BALANCE_EDIT": 1,
      "BUSINESS:SETTINGS_VIEW": 1,
      "BUSINESS:SETTINGS_EDIT": 1,
      "BUSINESS:TRENDS_VIEW": 1
    }
  }'

Responses

Role permissions updated successfully