PATCH
Update a B2B company account

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

companyId
string
required

Body

application/json

An omitted key keeps its stored value; an explicit null on external_id CLEARS it. A PUT would make an integration that computed a partial body blank external_id and get a 200 for it, and the next sync run would then create a duplicate account because its own key no longer resolves. A patch naming no field at all is a 400 rather than a no-op, because a bumped updated_at would make every incremental sync re-pull the row forever.

name
string

Must not be blank. Omit the key to leave it unchanged.

external_id
string | null

Send null to clear it, which is the real operation when an account moves out of the system that owned it. Omit the key to leave it alone.

status
enum<string>

The reversible withdrawal. Undone by patching it back to active.

Available options:
active,
inactive
metadata
object

Replaces the stored bag wholesale. Send {} to empty it.

Response

Success

data
object