200Successful Response
Schema: SuccessEnvelope_RenameImpactResponse_
successbooleanmessagestringcodestringdataRenameImpactResponse
/api/v1/counterparty-naming/rename-impactDeprecatedFor 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. Deprecated: use POST /counterparty-naming/rename-impact (ids in the body, no 1000-id cap). Kept for one release.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
transaction_idsstringrequiredComma-separated transaction UUIDs to rename (at most 1000).
new_namestringrequiredSchema: SuccessEnvelope_RenameImpactResponse_
successbooleanmessagestringcodestringdataRenameImpactResponseSchema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.