Update a counterparty alias

PATCH/api/v1/counterparty-aliases/{alias_id}

Change the display name on an existing counterparty alias.

Operation ID: update_counterparty_alias_api_v1_counterparty_aliases__alias_id__patch·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.

Parameters

Path

alias_idstringrequired

Request body

Schema: CounterpartyAliasUpdate

display_namestringrequired: New display name for this counterparty.

Responses

200Successful Response

Schema: SuccessEnvelope_CounterpartyAliasResponse_

successboolean
messagestring
codestring
dataCounterpartyAliasResponse

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

PATCH/api/v1/counterparty-aliases/{alias_id}

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/counterparty-aliases/{alias_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "display_name": "string"
}'