ACTIVE in the workspace (see Domains), billing details must be on file (Add Billing Details), and the account needs an active mailbox plan or add-on. A domain holds at most 5 mailboxes unless the account has a higher limit.successCount, failedCount and slotsPurchased. One provisioning request per workspace runs at a time; a concurrent call returns 409.domains, each holding its mailboxes.failed and failedCount in the response. The status is 200 even when some mailboxes fail.succeeded[].mailbox.id (see Statuses and polling).slotsPurchased. The request fails with 400 if the balance does not cover the cost. The charge is not reversed when an individual mailbox then fails; the unused slots stay on the add-on subscription and are reused the same day.GET /quick-setup (see Quick setup).IN_PROGRESS.| Status | Meaning |
|---|---|
IN_PROGRESS | Being created |
CREATING_PASSWORD | Being set up |
ACTIVE | Ready to use |
FAILED | Creation failed |
EXPIRED | The mailbox term ended |
GET /mailboxes with the mailbox id until status is ACTIVE or FAILED. To follow many mailboxes at once, use List Mailboxes, which groups mailboxes by domain and paginates by domain. The full address is username@domain.FAILED, fix the cause (for example update the domain's nameservers) and call Retry Failed Mailboxes with domainIds. It sets the failed mailboxes back to IN_PROGRESS and queues creation again, so poll again. A domain can be retried 3 times per 24 hours. Per-domain problems return 207 with the skipped domains in data, while domains that passed are still retried. Retrying uses existing slots and does not charge.appPassword, secret, and in the list also password) are returned by the read endpoints. Treat responses as sensitive.mailboxData, an array of instructions, each targeting one mailbox with mailboxId.GET /mailboxes and compare the fields.data. A rejected instruction appears as { "error": {} } while the request still returns 200, so check every element.username changes the email address.mailboxIds or domainIds (both or neither returns 422) and remove: true. Mailboxes keep working until the removal date. Send remove: false before then to clear the schedule. The admin mailbox of a domain can only be scheduled together with all other mailboxes of that domain.mailbox.updated webhook is emitted when it changes (see Webhooks).mailboxId. It returns the current code in otp and the seconds left in expiresIn; codes rotate every 30 seconds. A mailbox without a two-factor secret returns 400. For a Microsoft domain's admin account, send domainId instead. If both are sent, mailboxId is used.