Start free trial

Delete business

DELETE/api/v1/businesses/{business_id}

Delete a business and all associated resources (async via Temporal).

Safety: requires a JSON body with confirm_name matching the business's name (case-insensitive, trimmed). Guards against single-click muscle-memory deletes — this endpoint wipes ~80 related tables via a Temporal workflow and is irreversible.

Cleanup Process:

  1. For each Plaid connection:
    • Teal API cleanup (transactions, journal entries, source accounts, ledgers)
    • Local DB cleanup (Transactions → Line Entries → Journal Entries → Ledgers)
    • PlaidItem deletion
    • Plaid token revocation
  2. Teal instance deletion
  3. User associations cleanup
  4. Business record deletion

Notes:

  • Deletion runs asynchronously via Temporal workflow
  • Returns immediately with workflow_id for status polling
  • This action is irreversible
Operation ID: delete_business_api_v1_businesses__business_id__delete·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: BusinessDeleteRequest

business_idstring
confirm_namestringrequired

Exact business name as a typed confirmation. Must match the persisted business name (case-insensitive, trimmed). Required.

preserve_teal_instanceboolean
preserve_dz_usersboolean

Responses

202Successful Response

Schema: app__core__success__MessageResponse

successboolean
messagestring
codestring

422Validation Error

Schema: HTTPValidationError

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