Claim Inbound Domain
senderkit_inbound_domains_createClaim a custom domain for receiving mail (e.g. "inbound.acme.com"). Returns the DNS records (MX, DKIM) to publish at the domain's DNS host. If the domain already has live MX records pointing elsewhere, the call fails with an existing_mx error naming the current host(s); with acknowledgeExistingMx: true it claims the domain anyway, which redirects all of that domain's mail to SenderKit. Nothing is received until the records are live and verification completes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | Custom domain to claim for receiving, e.g. "inbound.acme.com". Must not already be claimed (by this or another workspace) and must not be a senderkit.com/senderkit.email suffix. | |
| context | Yes | Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): "Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization." | |
| acknowledgeExistingMx | No | Claim the domain even though it already has live MX records pointing elsewhere; this redirects all of the domain's mail to SenderKit. Without it, such a domain fails with an existing_mx error naming the current host(s). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Inbound domain id (UUID) — the id senderkit_inbound_domains_delete takes. | |
| kind | Yes | shared = the managed {slug}.in.senderkit.email domain; custom = a claimed domain. | |
| domain | Yes | The domain, e.g. inbound.acme.com. | |
| status | Yes | Verification state; only verified domains receive mail. | |
| records | Yes | DNS records the user must publish (custom domains only; empty for the shared domain). Surface them verbatim. | |
| createdAt | Yes | When the domain was claimed. | |
| verifiedAt | Yes | When verification completed, or null. |