Claim a custom inbound domain
Claims a domain or subdomain you own for receiving mail. Publish the
returned records, then poll GET /v1/inbound/domains/{id} until
status is verified.
Publishing our MX replaces wherever the domain’s mail currently goes.
If the domain already has a live mail host, this call 409s with
existing_mx and the current hosts; retry with
acknowledgeExistingMx: true once you’ve confirmed the redirect is
intended.
Authorizations
API key with an sk_live_ or sk_test_ prefix.
Body
Response
The claimed domain, with the DNS records to publish.
Inbound domain ID (the row's UUID — there is no separate public id).
"inbound.acme.com"
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.
shared, custom pending, verified, failed DNS records to publish for this domain to verify. Always empty
for shared domains — the wildcard MX on the shared domain
already covers them.