Update business

PUT /api/v1/businesses/{business_id}

Update business details.

This endpoint supports updating standard business information including:

Business name, mailbox, properties
Teal instance, Stripe account ID
Shopify integration details
Stripe subscription items (subscription_items)

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

business_id string required

Request body

Schema: BusinessUpdateRequest

name string: Business display name.
logo_url string: URL to business logo/avatar image.
default_currency string: Default currency for the business (USD, CAD, AUD, EUR, or GBP).
tax_year_end_month integer: Month when the tax/fiscal year ends (1-12).
accounting_basis string: Accounting basis: 'cash' or 'accrual'. Changes sync to Teal.
mailbox string: Email prefix for bill forwarding.
inventory_mode string: Inventory module flavor: 'cpg' exposes the Supply Chain map, production recipes, and landed COGS; 'finished_goods' hides the CPG-only surfaces.

Responses

200 Successful Response

Schema: BusinessResponse

id string: Business UUID.
firm_id string: Advisory firm UUID this business belongs to.
mailbox string: Email prefix for bill forwarding.
name string: Business name.
logo_url string: URL to business logo/avatar image.
default_currency string: Default currency for the business (USD, CAD, AUD, EUR, or GBP).
tax_year_end_month integer: Month when the tax/fiscal year ends (1-12). 12 = calendar year.
tax_year_display string: Human-readable tax year description (e.g., 'Calendar Year (Jan-Dec)').
created_at string · date-time: Creation timestamp.
updated_at string · date-time: Last update timestamp.
teal_instance_id string: Teal instance ID (API format).
teal_instance string: Teal database ID.
entries_start string · date-time: Start date for transaction imports.
stripe_account_id string: Connected Stripe account ID.
stripe_subscription_id string: Stripe subscription ID.
stripe_customer_id string: Stripe customer ID.
subscription_items object: Stripe subscription items/products linked to this business.
shopify_shop_domain string: Connected Shopify domain.
shopify_access_token_id string: Shopify token UUID.
ramp_connection_id string: Ramp connection UUID.
square_connection_id string: Square connection UUID.
finch_connection_id string: Finch payroll connection UUID.
hubspot_connection_id string: HubSpot connection UUID.
plaid_connections array · PlaidConnectionSchema: Connected bank accounts via Plaid.
slack_connected boolean: Whether a Slack webhook URL is configured.
sync SyncStatus: Teal sync status.
inventory_mode string: Inventory module flavor: 'cpg' or 'finished_goods'.

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

PUT /api/v1/businesses/{business_id}

bash

curl -X PUT 'https://api.ondayzero.com/api/v1/businesses/{business_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "logo_url": "string",
  "default_currency": "string",
  "tax_year_end_month": 0,
  "accounting_basis": "string",
  "mailbox": "string"
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/businesses/{business_id}', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "string",
  "logo_url": "string",
  "default_currency": "string",
  "tax_year_end_month": 0,
  "accounting_basis": "string",
  "mailbox": "string"
}),
});
const data = await response.json();

python

import httpx

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

payload = {
  "name": "string",
  "logo_url": "string",
  "default_currency": "string",
  "tax_year_end_month": 0,
  "accounting_basis": "string",
  "mailbox": "string"
}

response = httpx.put("https://api.ondayzero.com/api/v1/businesses/{business_id}", headers=headers, json=payload)
data = response.json()