Skip to main content
PATCH
Update Account Group
Updates the details of an existing account group: its name, its merchant ID, or the group it is nested under. Only the fields present in the body are changed. parent_code has three states: omit it to leave the parent untouched, send null to detach the group and make it a root again, or send another group’s id to nest the group under it. Nesting is structural only — it does not grant or revoke any permission.

Authorizations

PUBLIC-API-KEY
string
header
default:<Your PUBLIC-API-KEY>
required
PRIVATE-SECRET-KEY
string
header
default:<Your PRIVATE-SECRET-KEY>
required

Path Parameters

account_group_id
string<uuid>
required

Account group UUID.

Body

application/json
name
string

Account group name (min=1, max=255).

merchant_id
string

Local identifier (min=1, max=255).

parent_code
string<uuid> | null

The id of the group to nest this group under. Omit it to leave the parent unchanged; send null to detach the group and make it a root again. The parent must belong to the same organization and must not be the group itself or one of its descendants.

Response

OK

id
string<uuid>
name
string
merchant_id
string
parent_code
string<uuid> | null

The id of the group this group is nested under. null for a root (top-level) group.

created_at
string<date-time>
updated_at
string<date-time>