Mailboxes

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.

post/api/mailboxes

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/mailboxes
  • Auth: one of:
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: mailboxes:write)

Request body

displayNamestring
domainIdstring uuid required

A VERIFIED domain belonging to this project.

localPartstring required

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

projectIdstring uuid

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

quotaBytesinteger

NOT IMPLEMENTED — sending any value answers 400.

Response

Mailbox provisioned

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.