YOUHODLERBusiness API
Get access
View as Markdown

patchUpdate role

Required capabilityroles.manage

Patch a role. Requires If-Match.

Request

Request URL

PATCH
PATCH /roles/{role_id}

Request Body

application/json
{
  "name": "Updated Role Name",
  "description": "Updated description",
  "permissions": [
    "withdrawals.create"
  ]
}

Responses

Response

application/json
{
  "name": "Enterprise Admin",
  "description": "Full administrative access within an enterprise",
  "created_at": "2026-05-01T10:00:00Z",
  "etag": "W/\"a1b2c3d4\"",
  "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "permissions": [
    "withdrawals.create",
    "deposits.read",
    "clients.read"
  ],
  "platform_managed": false,
  "resource": "role",
  "scope_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "status": "active",
  "updated_at": "2026-05-01T10:00:00Z"
}

Operation succeeded.

Related endpoints