API
Mail administration
Mail domains, mailboxes, aliases, catch-all addresses and usage.
Every route here needs mail:admin, which owners and admins have. See Mail.
Every route below, with its parameters, request and response, errors and samples, is in the API reference.
| Route | What it does |
|---|---|
GET /v1/orgs/:orgId/mail/domains | The organization's mail domains with their status, DNS records and which records were found. |
POST /v1/orgs/:orgId/mail/domains | Adds a domain for sending and receiving mail: creates its sending identity and returns the DNS records to add. Hostnames under the platform's domain can't be added. |
POST /v1/orgs/:orgId/mail/domains/:domain/dkim/rotate | A new DKIM key for the domain's mail (platform-generated keys only; the customer's DNS stays). |
POST /v1/orgs/:orgId/mail/domains/:domain/verify | Checks the domain's DNS records and verification now. |
PATCH /v1/orgs/:orgId/mail/domains/:domain | Sets or clears the domain's catch-all mailbox, which receives mail to unknown addresses. |
DELETE /v1/orgs/:orgId/mail/domains/:domain | Removes a domain and its aliases. Its mailboxes must be deleted first. |
GET /v1/orgs/:orgId/mail/members | Members of the organization, to choose mailbox members from. |
GET /v1/orgs/:orgId/mail/admin/mailboxes | Every mailbox of the organization with its members and aliases. |
POST /v1/orgs/:orgId/mail/admin/mailboxes | Creates a mailbox at one of the organization's domains, with a sender name and members. |
PATCH /v1/orgs/:orgId/mail/admin/mailboxes/:mailboxId | Changes a mailbox's sender name or members. |
DELETE /v1/orgs/:orgId/mail/admin/mailboxes/:mailboxId | Deletes a mailbox with all of its mail, drafts, labels and aliases. |
POST /v1/orgs/:orgId/mail/admin/mailboxes/:mailboxId/aliases | Adds another address, at one of the organization's domains, that delivers to the mailbox. |
DELETE /v1/orgs/:orgId/mail/admin/aliases/:address | Removes an alias. |
GET /v1/orgs/:orgId/mail/usage | Messages sent, received, bounced and complained about per day, and the organization's sending limits. |