Reset a counterparty group to its detected names

POST/api/v1/counterparty-naming/reset

Recomputes the deterministic detected name (known merchant patterns, then descriptor cleanup) from each transaction's description, clears the registry link and any alias for the group. No AI is involved. Send dry_run to list the rows that would change with a plan_hash; send that plan_hash on the apply and it is refused (VALIDATION_640) if the rows moved.

Operation ID: reset_counterparty·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: ResetCounterpartyRequest

counterparty_namestringrequired
registry_idstring
dry_runboolean: List the rows that would change and a plan_hash; change nothing.
plan_hashstring: The plan_hash a dry run returned. If the rows moved since, the reset is refused (VALIDATION_640) and you preview again.

Responses

201Successful Response

Schema: SuccessEnvelope_ResetCounterpartyResponse_

successboolean
messagestring
codestring
dataResetCounterpartyResponse

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, 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/reset

bash

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