Sign in
latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

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:cp_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.

emailstring email

Updated contact email.

Example request

{
  "externalId": "customer_42",
  "entityType": "business",
  "displayName": "Jane Q. Doe",
  "email": "jane.doe@example.com",
  "identity": {
    "firstName": "Jane",
    "middleName": "Q",
    "lastName": "Doe",
    "secondLastName": "Garcia",
    "dateOfBirth": "1990-01-15",
    "phone": "+14155551234",
    "address": {
      "line1": "123 Main St",
      "line2": "Apt 4B",
      "city": "San Francisco",
      "postalCode": "94105",
      "countryCode": "US",
      "subdivisionCode": "CA"
    }
  }
}

Response

Counterparty updated

Example response

{
  "data": {
    "counterparty": {
      "id": "cp_example",
      "organizationId": "org_example",
      "projectId": "prj_example",
      "externalId": "customer_42",
      "entityType": "individual",
      "displayName": "Jane Doe",
      "email": "jane@example.com",
      "identity": {
        "firstName": "Jane",
        "middleName": "Q",
        "lastName": "Doe",
        "secondLastName": "Garcia",
        "dateOfBirth": "1990-01-15",
        "phone": "+14155551234",
        "address": {
          "line1": "123 Main St",
          "line2": "Apt 4B",
          "city": "San Francisco",
          "postalCode": "94105",
          "countryCode": "US",
          "subdivisionCode": "CA"
        }
      },
      "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"
  }
}