Check mailbox uniqueness

GET/api/v1/businesses/mailbox

Check if a mailbox is unique; validation and conflicts are handled by the service.

Rate-limited per user and per IP — the endpoint is otherwise an enumeration oracle for the mailbox namespace.

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

Query

mailboxstringrequired: Mailbox to check for uniqueness

Responses

200Successful Response

Schema: SuccessEnvelope_MailboxUniquenessResponse_

successboolean
messagestring
codestring
dataMailboxUniquenessResponse

400Bad Request - Invalid input

409Conflict - Resource already exists

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

429Too Many Requests - Rate limit exceeded

Code samples

GET/api/v1/businesses/mailbox

bash

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