Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Mailboxes

Connect Callback

Called by the provider when a hosted-auth flow succeeds (not by users).

API key access

This route has its own authentication (or none); an API key is not used here.
POST/api/v1/mailboxes/connect/callback

Query Parameters

statestring
Length1 <= length <= 1024

Request Body

Empty Object

Response Body

curl -X POST "http://localhost:8000/api/v1/mailboxes/connect/callback?state=string" \  -H "Content-Type: application/json" \  -d '{    "property1": null,    "property2": null  }'
{
  "status": "ok",
  "mailbox_id": "4d23d1af-2eef-4598-a5e0-1f19ae0b0c14"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Check Sending Domain

Look up a sending domain's SPF, DKIM (common selectors), DMARC and MX records over DNS-over-HTTPS (free, no key). Admin+. Only a domain one of the workspace's mailboxes sends from; a result younger than `DELIVERABILITY_DNS_RECHECK_SECONDS` is returned as it is (`cached`).

Connect Mailbox

Start connecting a Gmail/Outlook/IMAP mailbox: returns the provider's hosted-auth URL. When the user finishes, the provider calls ``/mailboxes/connect/callback`` and the mailbox appears in the list. Pass ``mailbox_id`` to reconnect an existing mailbox. The browser is then sent to ``{WEB_BASE_URL}/app/settings/mailboxes`` (or ``/app/onboarding`` with ``return_to: onboarding``) with ``?connected=1`` on success or ``?connected=0`` on failure.