Preview what a remembered rename would also relabel

POST/api/v1/counterparty-naming/rename-impact

For a rename of transaction_ids to new_name with remember=true (a saved rename), counts the OTHER transactions the saved rename would relabel: rows on the same registry entries (other_rows_by_registry) and rows with the same raw name (other_rows_by_name). Rows renamed by hand keep their own name and are not counted. processor_guarded is true when some rows belong to a payment processor that pays many parties; those are renamed on their own. Nothing is changed. The ids go in the body, so a selection of any size is one request.

Operation ID: counterparty_rename_impact_post·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: RenameImpactRequest

transaction_idsarray · stringrequired: The transactions a remembered rename would rename.
new_namestringrequired

Responses

200Successful Response

Schema: SuccessEnvelope_RenameImpactResponse_

successboolean
messagestring
codestring
dataRenameImpactResponse

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/rename-impact

bash

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