Mailboxes
The mailboxes that send your campaigns. List and change them, connect a whole Google Workspace in one step, connect a mailbox from any other email provider with its server settings, or order new mailboxes on new domains: a quote, a yes, then a payment link or the saved card.
The mailboxes that send your campaigns. List and change them, connect a whole Google Workspace in one step, connect a mailbox from any other email provider with its server settings, or order new mailboxes on new domains: a quote, a yes, then a payment link or the saved card.
| Operation | Method | Path |
|---|---|---|
| List mailboxes | GET | /api/v1/inboxes |
| Disconnect a mailbox | DELETE | /api/v1/inboxes/{email} |
| Change a mailbox | PATCH | /api/v1/inboxes/{email} |
| Change many mailboxes | POST | /api/v1/inboxes/update |
| Connect a Google Workspace | POST | /api/v1/inboxes/google-workspace |
| Email provider settings | GET | /api/v1/inboxes/smtp/presets |
| Test a mailbox sign-in | POST | /api/v1/inboxes/smtp/test |
| Connect a mailbox from any provider | POST | /api/v1/inboxes/smtp |
| Connect many mailboxes | POST | /api/v1/inboxes/smtp/bulk |
| Domain endings on offer | GET | /api/v1/inboxes/endings |
| Suggest domain names | GET | /api/v1/inboxes/domains/suggest |
| Quote new mailboxes | POST | /api/v1/inboxes/quote |
| List mailbox orders | GET | /api/v1/inboxes/orders |
| Order new mailboxes | POST | /api/v1/inboxes/orders |
| Get a mailbox order | GET | /api/v1/inboxes/orders/{order_id} |
| Cancel a bundle of mailboxes | POST | /api/v1/inboxes/orders/{order_id}/bundles/{bundle_id}/cancel |
| Turn a domain's renewal off or on | POST | /api/v1/inboxes/orders/{order_id}/domains/{domain}/renewal |
Every page below is generated from the OpenAPI document and carries a request sample in the language you pick. The playground sends to production with your own key.