Skip to main content
PATCH
Update an account

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Headers

Idempotency-Key
string
required

Client-supplied key that deduplicates retried requests. Reusing a key returns the original result instead of repeating the action.

Api-Signature
string
required

A hex-encoded Ed25519 signature of timestamp_epoch_seconds + uppercase(http_method) + request_path + request_body.

Pattern: ^[0-9A-Fa-f]{128,160}$
Api-Timestamp
integer<int64>
required

Current timestamp, represented as unix epoch seconds

If-Match
string

Optional concurrency token, taken from a prior response's ETag header. When set, the update is rejected with 409 Conflict if the account has changed since that ETag was issued. An empty value is the same as no header.

Path Parameters

accountId
string<uuid>
required

Unique identifier for the account

Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

Body

application/json

Account fields to update

Details of the segregatedAccount to update.

type
enum<string>
required

Set to SEGREGATED to create a segregated account.

Available options:
SEGREGATED
name
string

The name of the account.

externalId
string

The external unique identifier used to identify this account.

Response

Success

data
Segregated Account Details · object
required

A segregatedAccount underneath an FBO or omnibus parent account. Whether it is disclosed or undisclosed follows from its parent.