Skip to main content
POST
Order Mailboxes
This call bills the team: each mailbox is a monthly seat on the domain’s mailbox subscription, prorated on the first invoice. Nothing can be canceled through the API; use the lemlist app.
The mailbox type is the domain’s registrar: Google Workspace, Microsoft 365 or SMTP. The order is checked as a whole: one invalid mailbox refuses it all, and nothing is billed. You can order right after Purchase Domain. The mailboxes stay ordered until the domain is set up, then they are billed and created. Follow them with List Domain Mailboxes.

Rules by provider

Pass assignToUser for each mailbox: without it the mailbox goes to the user of the API key.This call is not idempotent. Calling it again with the same usernames answers 409 (Some emails are already taken): check List Domain Mailboxes before retrying.
Requires the Manage domains permission on the user of the API key.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

domainId
string
required

The domain, from List Domains or Purchase Domain

Body

application/json
emails
object[]
required
Minimum array length: 1

Response

Mailboxes ordered

added
integer
mailboxes
object[]