Batch update counterparty

PATCH/api/v1/transactions/batch/counterparty

Set the counterparty name for multiple transactions at once. With remember the name is also saved as a rename for the business's other transactions under the same registry entry or raw name (see POST /counterparty-naming/rename-impact for the count first); the response reports rows_renamed, aliases_created and other_rows_relabelled.

Operation ID: update_transactions_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: TransactionBulkUpdateCounterpartyRequest

transaction_idsarray · stringrequired: Array of transaction UUIDs to update.
counterpartystringrequired: Counterparty / merchant name to set on all selected transactions.
rememberboolean: When true, also save the rename for the business (a counterparty alias): the business's OTHER transactions under the same registry entry or raw name, existing and future, display the new name too, except rows someone renamed by hand. Registry-linked transactions keep their registry link and store the new name; unlinked ones get a name-keyed alias for their previous raw string. Rows from a payment processor that pays many parties (Gusto, ADP, PayPal, Stripe, Bill.com, ...) are renamed on their own and never aliased. Call GET /counterparty-naming/rename-impact first to show how many other rows change. When false (default), only the selected rows are renamed.

Responses

200Successful Response

Schema: SuccessEnvelope_TransactionCounterpartyRenameResponse_

successboolean
messagestring
codestring
dataTransactionCounterpartyRenameResponse

400Bad Request - Invalid input

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.

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.

404Not Found - Resource does not exist

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

PATCH/api/v1/transactions/batch/counterparty

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/transactions/batch/counterparty' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "counterparty": "Acme Corp",
  "remember": true,
  "transaction_ids": [
    "019ab37c-0001-7000-8000-000000000001",
    "019ab37c-0002-7000-8000-000000000002"
  ]
}'