Skip to main content
PATCH
Update an account

Authorizations

Authorization
string
header
required

JWT bearer token. Include as Authorization: Bearer <token>. See the Authentication guide for how to obtain one.

Headers

X-Trace-Version
string

API version. Omit to use the default version.

Example:

"1"

X-Idempotency-Key
string<uuid>
required

Unique key to ensure idempotent request processing. Required on all POST, PUT, and PATCH requests.

Path Parameters

accountId
string<uuid>
required

UUID of the account.

Body

application/json

Request body for updating an account. The supplied owner replaces the current owner profile; assets are not modifiable after creation.

owner
Company · object
required

The legal entity that owns the account. Discriminated by type.

Response

Account updated.

id
string<uuid>
required
read-only
Example:

"a1b2c3d4-5e6f-7890-abcd-ef1234567890"

customer
object
required
owner
Company · object
required

The legal entity that owns the account. Discriminated by type.

assets
object[]
required

Assets enabled on the account, with the onboarding status of the underlying provider account.

requirements
object
required

Requirement buckets grouped by lifecycle stage.

tags
object[]
required

System-managed labels attached to the account. Some tags propagate to operations executed against this account.

Example:
currentState
object
required

A point-in-time state of the account.

states
object[]
required

Full state history of the account.

createdAt
string<date-time>
required
read-only
Example:

"2026-01-15T10:30:00Z"

updatedAt
string<date-time>
required
read-only
Example:

"2026-01-15T10:30:00Z"

sourceAccountId
string<uuid> | null

Parent account ID. Null for named accounts.

Example:

null