Create a mailbox
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.
better-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- body
projectId?stringDefaults to the project the credential resolves to. Naming a different one is refused.
uuiddomainId*stringA VERIFIED domain belonging to this project.
uuidlocalPart*stringThe part before the @, e.g. support. Lowercased server-side.
1 <= length <= 64displayName?stringlength <= 120quotaBytes?integerNOT IMPLEMENTED — sending any value answers 400.
0 < valueMailbox provisioned
application/json- response
success*truetruedata*A receiving mailbox on one of the project's verified domains.
curl -X POST 'https://api.sendly.now/api/mailboxes' \ -H 'Content-Type: application/json' \ -d '{ "domainId": "8a0b02c3-fdd8-452e-bc6e-ef07a335ec7e", "localPart": "string"}'{ "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" }}