{"openapi":"3.1.0","info":{"title":"POST /api/v1/businesses/{business_id}/mailbox","version":"1.0.0","description":"Provision inbound mailbox"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/businesses/{business_id}/mailbox":{"post":{"tags":["businesses"],"summary":"Provision inbound mailbox","description":"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).","operationId":"provision_business_mailbox_api_v1_businesses__business_id__mailbox_post","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_BusinessMailboxProvisionResponse_"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BusinessMailboxProvisionResponse":{"properties":{"mailbox":{"type":"string","title":"Mailbox","description":"Inbound mailbox slug (local part)."},"inbox_email":{"type":"string","title":"Inbox Email","description":"Full forwarding address for the AP inbox, composed from the slug and the environment's inbound email domain."},"created":{"type":"boolean","title":"Created","description":"True when this call minted the slug; False when it already existed."}},"type":"object","required":["mailbox","inbox_email","created"],"title":"BusinessMailboxProvisionResponse","description":"Response for ``provision_business_mailbox``.\n\nReturned whether the call minted a new slug or the business already had\none — the endpoint is idempotent and never overwrites an existing mailbox."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_BusinessMailboxProvisionResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/BusinessMailboxProvisionResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[BusinessMailboxProvisionResponse]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}