Skip to main content
PATCH
Update account

Authorizations

Authorization
string
header
required

Enter Auth0 JWT token

Path Parameters

accountId
string<uuid>
required

Body

application/json
status
enum<string>
required

Lifecycle transition (suspend or close the account)

Available options:
active,
suspended,
closed
Example:

"suspended"

Response

accountType
enum<string>
required
Available options:
master,
sub
country
string
required

ISO-3166 alpha-2

Example:

"SN"

createdAt
string<date-time>
required
id
string<uuid>
required

Account record id

parentAccountId
string<uuid>
required

The master that owns this account. Derived from the API key.

status
enum<string>
required
Available options:
pending,
active,
suspended,
closed