Skip to main content
PATCH
Updates a role in the caller's organization.

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Headers

X-Organization-ID
string<uuid>

ID of the organization to scope this operation to. When omitted, the role is updated in the caller's own organization. Must be a valid non-empty UUID. Present but empty or malformed values return 400.

Path Parameters

roleId
string<uuid>
required

The ID of the role to update.

Body

Cancellation token.

appliesToOrgType
null | enum<string>

Two states accepted: absent = leave unchanged, value = set (must be a ranked type the owning org holds). Clearing to null is rejected, roles cannot become unscoped.

Available options:
BANK,
EMBEDDED,
PLATFORM,
TRANSACTOR,
VERTICAL_SOFTWARE_PROVIDER,
null
description
null | string

Three states: absent = leave unchanged, null = clear, value = set.

key
null | string
name
null | string
sortOrdinal

Two states accepted: absent = leave unchanged, value = set (must be at least 5000). Clearing to null is rejected.

Response

Role updated successfully.

id
string<uuid>
required
createdDateTime
string<date-time>
required
key
required
Available options:
bank:admin,
embedded:admin,
embedded:bookkeeper,
embedded:employee,
embedded:finance_admin,
platform:admin,
vsp:admin
name
string
required
sortOrdinal
required
status
string
required
updatedDateTime
string<date-time>
required
appliesToOrgType
null | string
description
null | string
icon
null | string
isSystemRole
boolean
organizationId
null | string<uuid>