Counterparties

Update counterparty

Updates counterparty attributes. At least one field must be provided. Use null on externalId to clear it.

patch/v1/counterparties/{counterpartyId}

Path parameters

counterpartyIdstring required

Counterparty identifier.

Example:cpty_example

Counterparty identifier.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Request body

externalIdstring nullable

Updated opaque external ID. Do not include personal data. Use null to clear.

entityType'individual' | 'business'

Updated counterparty entity type.

displayNamestring

Updated searchable display name. Keep it minimal.

Example request

{
  "externalId": "customer_42",
  "entityType": "business",
  "displayName": "Jane Q. Doe"
}

Response

Counterparty updated

Example response

{
  "data": {
    "counterparty": {
      "id": "cpty_example",
      "organizationId": "org_example",
      "projectId": "prj_example",
      "externalId": "customer_42",
      "entityType": "individual",
      "displayName": "Jane Doe",
      "status": "active",
      "createdBy": "usr_example",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-02T00:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes

Changed in 2 of the 9 revisions of this API.28

Aug 28, 202613f3098243d622See the full diff
- ▲
  removed the required property data/counterparty/email from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/counterparty/identity from the response with the 200 status
  response-required-property-removed
- ●
  removed the request property email
  request-property-removed
- ●
  removed the request property identity
  request-property-removed
Aug 15, 20263e302bba53866See the full diff
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 403
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 500
  response-property-enum-value-added

Full history