Merge counterparty groups into one name

POST/api/v1/counterparty-naming/merge

Re-points every transaction in the source groups to target_name (and target_registry_id when given), marks them user-edited so re-syncs keep the name, and remembers each folded-in raw string as an alias so future ingests display the chosen name.

Operation ID: merge_counterparties·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: MergeCounterpartiesRequest

sourcesarray · CounterpartyRefrequiredCounterpartyRef

Groups to fold into the target.

2 fields

counterparty_namestringrequired
registry_idstring

target_namestringrequired

Name every merged transaction gets.

target_registry_idstring

Registry entry the merged transactions should link to. Pass the registry_id of the chosen canonical group when it is linked; omit to leave the merged transactions unlinked.

Responses

201Successful Response

Schema: SuccessEnvelope_MergeCounterpartiesResponse_

successboolean
messagestring
codestring
dataMergeCounterpartiesResponse

401Unauthorized - Missing/invalid token or no access to this business

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

Code samples

POST/api/v1/counterparty-naming/merge

bash

curl -X POST 'https://api.ondayzero.com/api/v1/counterparty-naming/merge' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "sources": [],
  "target_name": "string"
}'