Skip to main content
POST

Authorizations

Authorization
string
header
required

Send a live API key in the Authorization header. Keys in query strings are rejected. A staging key never authenticates against production.

Headers

Idempotency-Key
string
required

Unique caller-generated value for safely retrying this creation. It is scoped to the authenticated account and operation and must not contain a secret or API key.

Required string length: 16 - 255
Pattern: ^[\x21-\x7E]+$

Body

application/json
local_part
string

Optional lowercase custom name. The server normalizes and validates it, rejects reserved names, and never reallocates a previously issued name.

Required string length: 1 - 64
Pattern: ^[a-z0-9](?:[a-z0-9._-]{0,62}[a-z0-9])?$
domain
string<hostname>

Optional active domain returned by GET /v1/domains.

Maximum string length: 253

Response

The email was created, or the original successful creation was replayed.

data
object
required
Last modified on August 8, 2026