Sign in
Mailboxes

Check mailbox address availability

Changed on

Checks whether an email address can be reserved for mailbox creation. @myagent.mx availability is global across all teams; custom-domain availability is scoped to the caller's team and requires a verified send/receive mailbox domain.

get/mailboxes/availability

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailboxes/availability
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.admin.create)

Query parameters

emailstring required

Email address to check.

Example:agent@myagent.mx

Response

Mailbox address availability

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "email": "agent@myagent.mx"
  }
}

Changes