POST
Register a sending domain with a connected provider

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Body

application/json

AN UPSERT. Registering a domain that is already registered re-asks the provider and refreshes what is stored, so a repeat is the retry rather than a conflict. dkim_record and status are REFUSED BY NAME rather than ignored. The record is the provider's own instruction, and one accepted from a caller could be an attacker's signing key published in the merchant's DNS on this API's say-so; the status is the provider's verdict, recorded through PUT /api/v1/email-domains/{domain} once you have it.

provider
string
required

Which connected relay is asked to verify. It must name a connection this store has AND has enabled, or the call is refused 404 rather than storing a registration no provider knows about. List them at /api/v1/email-providers.

domain
string
required

The sending domain, for example mail.example.com.

Response

Created

data
object