Skip to Content
SendlySendly
API ReferenceMailboxes

Create a mailbox

POST
/api/mailboxes

Provision a real receiving mailbox — support@yourdomain.com — on a domain you have already verified.

Three consequences worth knowing before you call it:

  • It changes how your domain's mail is routed. The first mailbox on a domain turns receiving on for that domain, so mail addressed there starts arriving at Sendly instead of wherever it went before.
  • The domain must be verified. An unverified domain answers 409; creating a mailbox is not a way to skip DNS.
  • Ten per project. The eleventh answers 409. Deleted mailboxes free their slot; failed ones never consumed one.

Retrying a failed provision with the same address reclaims the failed row rather than answering 409 — but only for the same project and the same domain.

quotaBytes is accepted by the schema and REFUSED with a 400. Quotas are not implemented, and the field is still parsed so that asking for one is an error rather than a silently dropped key.

Requires the mailboxes:write scope — Create and delete mailboxes on your verified domains.

cookiebetter-auth.session_token<token>

BetterAuth session cookie. Used by the dashboard / browser clients. When present, the active project is taken from the x-project-id header.

application/json
  1. body
projectId?string

Defaults to the project the credential resolves to. Naming a different one is refused.

Formatuuid
domainId*string

A VERIFIED domain belonging to this project.

Formatuuid
localPart*string

The part before the @, e.g. support. Lowercased server-side.

Length1 <= length <= 64
displayName?string
Lengthlength <= 120
quotaBytes?integer

NOT IMPLEMENTED — sending any value answers 400.

Range0 < value

Response Body

Mailbox provisioned

application/json
  1. response
success*true
Value intrue
data*

A receiving mailbox on one of the project's verified domains.

Example Request
curl -X POST 'https://api.sendly.now/api/mailboxes' \  -H 'Content-Type: application/json' \  -d '{  "domainId": "8a0b02c3-fdd8-452e-bc6e-ef07a335ec7e",  "localPart": "string"}'
Example Response
{  "success": true,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "address": "user@example.com",    "displayName": "string",    "status": "PROVISIONING",    "quotaBytes": 0,    "domainId": "8a0b02c3-fdd8-452e-bc6e-ef07a335ec7e",    "createdAt": "2019-08-24T14:15:22Z"  }}