Skip to main content
POST
Claim a custom inbound domain

Authorizations

Authorization
string
header
required

API key with an sk_live_ or sk_test_ prefix.

Body

application/json
domain
string
required

The domain or subdomain to receive mail on, e.g. inbound.acme.com.

Required string length: 4 - 253
acknowledgeExistingMx
boolean

Required to claim a domain that already has a live MX pointing somewhere else — publishing ours would redirect that domain's existing mail.

Response

The claimed domain, with the DNS records to publish.

id
string<uuid>

Inbound domain ID (the row's UUID — there is no separate public id).

domain
string
Example:

"inbound.acme.com"

kind
enum<string>

shared is the workspace's auto-provisioned {slug}.in.senderkit.email domain, which needs no DNS of its own. custom is a domain you claimed and must verify by publishing records.

Available options:
shared,
custom
status
enum<string>
Available options:
pending,
verified,
failed
records
object[]

DNS records to publish for this domain to verify. Always empty for shared domains — the wildcard MX on the shared domain already covers them.

verifiedAt
string<date-time> | null
createdAt
string<date-time>