Update a Counterparty
Update a Counterparty (partial; unknown keys 400).
Authorizations
Token from POST /auth/token
Path Parameters
Counterparty ID (ctp_ prefix).
Body
Partial update — every field optional; omitted fields are unchanged. Unknown fields are rejected with 400 (strict decode) by the handler.
1 - 140individual or business.
individual, business The counterparty's postal address.
Contact email address.
Phone in E.164 format.
Tax ID (CPF, CNPJ, SSN, etc.). Required for some external-account types.
Date of birth (YYYY-MM-DD).
Free-form key-value pairs stored on the resource and echoed back on reads.
Response
The request has succeeded.
A third party a customer transacts with — an entry in the customer's address book. Counterparties will own External Accounts (registered payment destinations) in a later slice.
Registered address. Required since v0.11 — always present in responses.
Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.
^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$counterparty Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.
^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$Lifecycle of a counterparty. rejected is reserved for create-time
compliance screening (not yet active); deleted marks a soft-deleted
record that remains readable by id.
active, rejected, deleted Set when status = rejected.
Full legal name or registered business name.
individual, business ISO 3166-1 alpha-2.