Start free trial

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)

Note: This endpoint updates business details only.

Args: business_id (str): The ID of the business to update. payload (BusinessUpdateRequest): The updated business details.

Returns: BusinessResponse: The updated business details.

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_idstringrequired

Request body

Schema: BusinessUpdateRequest

namestring

Business display name.

logo_urlstring

URL to business logo/avatar image.

default_currencystring

Default currency for the business (USD, CAD, AUD, EUR, or GBP).

tax_year_end_monthinteger

Month when the tax/fiscal year ends (1-12).

accounting_basisstring

Accounting basis: 'cash' or 'accrual'. Changes sync to Teal.

mailboxstring

Email prefix for bill forwarding.

inventory_modestring

Inventory module flavor: 'cpg' exposes the Supply Chain map, production recipes, and landed COGS; 'finished_goods' hides the CPG-only surfaces.

Responses

200Successful Response

Schema: SuccessEnvelope_BusinessResponse_

successboolean
messagestring
codestring
dataBusinessResponse

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject