Update a counterparty default

PATCH /api/v1/counterparty-defaults/{default_id}

Update fields on an existing counterparty default.

Operation ID: update_counterparty_default_api_v1_counterparty_defaults__default_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

default_id string required

Request body

Schema: CounterpartyDefaultUpdate

default_ledger_id string
memo string
mark_personal boolean

Responses

200 Successful Response

Schema: CounterpartyDefaultResponse

id string required
business_id string required
registry_id string required
counterparty_name string required
default_ledger_id string required
default_ledger_name string
memo string required
mark_personal boolean required
created_at string · date-time required
updated_at string · date-time required

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

PATCH /api/v1/counterparty-defaults/{default_id}

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/counterparty-defaults/{default_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "default_ledger_id": "string",
  "memo": "string",
  "mark_personal": false
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/counterparty-defaults/{default_id}', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "default_ledger_id": "string",
  "memo": "string",
  "mark_personal": false
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "default_ledger_id": "string",
  "memo": "string",
  "mark_personal": false
}

response = httpx.patch("https://api.ondayzero.com/api/v1/counterparty-defaults/{default_id}", headers=headers, json=payload)
data = response.json()