Provision inbound mailbox

POST/api/v1/businesses/{business_id}/mailbox

Mint an inbound mailbox slug for a business that has none, so vendor bills can be forwarded to its AP inbox. Idempotent: a business that already has a mailbox gets it back unchanged (never overwritten).

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

Responses

200Successful Response

Schema: SuccessEnvelope_BusinessMailboxProvisionResponse_

successboolean
messagestring
codestring
dataBusinessMailboxProvisionResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

POST/api/v1/businesses/{business_id}/mailbox

bash

curl -X POST 'https://api.ondayzero.com/api/v1/businesses/{business_id}/mailbox' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'