Add a sending domain

POST

/v1/email/domains

bird email domains create mail.acme.com

Registers a new sending domain and returns the DNS records to publish for it. The DKIM TXT record proves ownership, and together with the return-path CNAME (which also covers SPF; no separate SPF record is needed) and a DMARC policy it gates sending. The tracking CNAME is optional and gates branded link tracking only. Publish the records at your DNS provider, then check progress with Trigger domain verification; Bird also re-checks published records automatically. Setup walkthrough: Sending domains.

The domain starts in pending status. A domain already registered in this workspace returns 409, and creation beyond your organization's domain quota returns 422 E10000. A domain that never verifies ownership is removed after about 14 days, with a reminder email first.

Request Payload

domain

string

आवश्यक

The domain you will send from — the domain of your from addresses. Use a dedicated subdomain (e.g. mail.acme.com) rather than your registered domain so sending reputation stays separate from other services on the domain.

return_path

object

Return-path (bounce) domain configuration. The return-path domain receives bounce and complaint notifications for mail sent from this domain and is what mailbox providers check for SPF. Provide only the name part; Bird adds the sending domain automatically.

चाइल्ड पैरामीटर दिखाएँ

return_path.name

string

आवश्यक

Name part to use for the return-path domain. For example, send on mail.acme.com becomes send.mail.acme.com. Defaults to send when omitted at creation.

tracking

object

Tracking domain configuration for branded open and click tracking URLs. Provide only the name part; Bird adds the sending domain automatically. A domain created with no tracking configuration defaults to the name links. Tracked links are served over HTTPS once the tracking record verifies.

चाइल्ड पैरामीटर दिखाएँ

tracking.name

string

आवश्यक

Name part to use for branded open and click tracking URLs. For example, links on mail.acme.com becomes links.mail.acme.com.

dkim

object

DKIM signing configuration.

चाइल्ड पैरामीटर दिखाएँ

dkim.mode

string

How the DKIM public key is published in your DNS.

txt — you publish the DKIM public key as a TXT record. Key rotation requires updating the record.
delegated — preview, currently unavailable; supplying it returns 422. When available, you publish a single CNAME and Bird hosts and rotates the key with no further DNS changes on your side.

Possible values: txt, delegated

settings

object

Per-domain behavior toggles. Changes apply immediately to new sends.

चाइल्ड पैरामीटर दिखाएँ

settings.click_tracking

boolean

Rewrite links in HTML email through your tracking domain to record clicks. You can enable this before your tracking domain has verified — it begins working once verification completes. A tracking domain must be configured; enabling it without one returns 409.

settings.open_tracking

boolean

Insert a tracking pixel in HTML email to record opens. You can enable this before your tracking domain has verified — it begins working once verification completes. A tracking domain must be configured; enabling it without one returns 409.

Response Payload

string

आवश्यक

workspace_id

string

आवश्यक

domain

string

आवश्यक

The sending domain name. Set at creation and immutable.

vendor

string

आवश्यक

The DNS provider hosting this domain's nameservers, so you know which provider's dashboard to manage the required DNS records in. Returns "other" when the provider has not been detected or is not recognized.

Possible values: other, cloudflare, route53, godaddy, namecheap, google, azure, digitalocean, squarespace

status

string

आवश्यक

Domain ownership verification, proven by the DKIM record. Readiness to send or track is reported separately per capability under capabilities.*.status.

pending — the DKIM record has not been published yet. - verified — the DKIM record is in place; ownership is confirmed. - failed — a DKIM record exists but does not match the expected value (for example a stale record from an earlier setup), or a previously verified record was removed. Correct the record to recover.
temporary_failure — DNS resolution failed transiently (timeout, unreachable nameserver). Verification is queued for retry on a 72h cadence; customer should not edit DNS records before the retry runs.
rejected — the domain was refused for policy reasons and cannot be used for sending. Contact support if you believe this is an error.

Possible values: pending, verified, failed, temporary_failure, rejected

settings

object

आवश्यक

Per-domain behavior toggles. Changes apply immediately to new sends.

चाइल्ड एट्रिब्यूट दिखाएँ

settings.click_tracking

boolean

settings.open_tracking

boolean

dkim

object

आवश्यक

Active DKIM signing configuration for the domain.

चाइल्ड एट्रिब्यूट दिखाएँ

dkim.mode

string

आवश्यक

How the DKIM public key is published in your DNS. txt — you publish the key as a TXT record. delegated — you publish a single CNAME and Bird hosts and rotates the key.

Possible values: txt, delegated

dkim.selector

string

आवश्यक

DKIM selector used to sign mail from this domain.

dkim.key_size

integer

आवश्यक

RSA key size in bits.

capabilities

object

आवश्यक

चाइल्ड एट्रिब्यूट दिखाएँ

capabilities.sending

object

आवश्यक

Overall authorization to send from this domain. Verified when the DKIM record, the return-path CNAME, and a DMARC policy are all in place. Required for live sends.

चाइल्ड एट्रिब्यूट दिखाएँ

capabilities.sending.status

string

आवश्यक

Capability verification status.

pending — verification has not run, or is currently running. - verified — all DNS records for this capability resolved with the expected values.
warning — a record for this capability verified before and a recent check no longer matches, but it is still within the grace period. Sending is not yet affected; fix it before the grace period ends.
failed — DNS records resolved but at least one value is wrong. Update your DNS to recover.
temporary_failure — DNS lookup failed transiently. Verification is queued for retry; don't change DNS records yet.
not_configured — the capability is not set up on this domain (e.g. no tracking domain configured).

Possible values: pending, verified, warning, failed, temporary_failure, not_configured

capabilities.sending.domain

nullable string

Hostname this capability is configured with — the return-path domain, the tracking domain, or the domain where the DMARC policy was found. Null when not applicable or not configured.

capabilities.sending.pending

object

A staged configuration change awaiting DNS verification. The currently active configuration keeps serving until the staged one verifies, at which point it is promoted automatically. Submitting another change for the same capability replaces the staged value.

चाइल्ड एट्रिब्यूट दिखाएँ

capabilities.sending.pending.domain

string

आवश्यक

Hostname the capability will use once the staged change verifies.

capabilities.sending.pending.status

string

आवश्यक

Verification status of the staged change. pending — waiting for the DNS records to be detected. failed — the records resolved with wrong values; correct them or submit a different change. temporary_failure — DNS lookup failed transiently and will be retried.

Possible values: pending, failed, temporary_failure

capabilities.sending.reason

nullable string

Machine-readable reason code for a failed capability status. Only set when status is failed. Use this to display a specific message to users rather than a generic failure message.

tracking_domain_in_use — the link tracking subdomain is already claimed by another organization.

capabilities.return_path

object

आवश्यक

Return-path (bounce) CNAME verification. The return-path domain receives bounce and complaint notifications and is what mailbox providers check for SPF — no separate SPF record is needed.

चाइल्ड एट्रिब्यूट दिखाएँ

capabilities.return_path.status

string

आवश्यक

Capability verification status.

pending — verification has not run, or is currently running. - verified — all DNS records for this capability resolved with the expected values.
warning — a record for this capability verified before and a recent check no longer matches, but it is still within the grace period. Sending is not yet affected; fix it before the grace period ends.
failed — DNS records resolved but at least one value is wrong. Update your DNS to recover.
temporary_failure — DNS lookup failed transiently. Verification is queued for retry; don't change DNS records yet.
not_configured — the capability is not set up on this domain (e.g. no tracking domain configured).

Possible values: pending, verified, warning, failed, temporary_failure, not_configured

capabilities.return_path.domain

nullable string

Hostname this capability is configured with — the return-path domain, the tracking domain, or the domain where the DMARC policy was found. Null when not applicable or not configured.

capabilities.return_path.pending

object

चाइल्ड एट्रिब्यूट दिखाएँ

capabilities.return_path.pending.domain

string

आवश्यक

Hostname the capability will use once the staged change verifies.

capabilities.return_path.pending.status

string

आवश्यक

Possible values: pending, failed, temporary_failure

capabilities.return_path.reason

nullable string

Machine-readable reason code for a failed capability status. Only set when status is failed. Use this to display a specific message to users rather than a generic failure message.

tracking_domain_in_use — the link tracking subdomain is already claimed by another organization.

capabilities.dmarc

object

आवश्यक

DMARC policy check. Satisfied by any valid DMARC record covering the sending domain — on the domain itself or on its registered (organizational) domain; domain reports where the policy was found. A minimal policy of p=none is sufficient.

चाइल्ड एट्रिब्यूट दिखाएँ

capabilities.dmarc.status

string

आवश्यक

Capability verification status.

pending — verification has not run, or is currently running. - verified — all DNS records for this capability resolved with the expected values.
warning — a record for this capability verified before and a recent check no longer matches, but it is still within the grace period. Sending is not yet affected; fix it before the grace period ends.
failed — DNS records resolved but at least one value is wrong. Update your DNS to recover.
temporary_failure — DNS lookup failed transiently. Verification is queued for retry; don't change DNS records yet.
not_configured — the capability is not set up on this domain (e.g. no tracking domain configured).

Possible values: pending, verified, warning, failed, temporary_failure, not_configured

capabilities.dmarc.domain

nullable string

Hostname this capability is configured with — the return-path domain, the tracking domain, or the domain where the DMARC policy was found. Null when not applicable or not configured.

capabilities.dmarc.pending

object

चाइल्ड एट्रिब्यूट दिखाएँ

capabilities.dmarc.pending.domain

string

आवश्यक

Hostname the capability will use once the staged change verifies.

capabilities.dmarc.pending.status

string

आवश्यक

Possible values: pending, failed, temporary_failure

capabilities.dmarc.reason

nullable string

Machine-readable reason code for a failed capability status. Only set when status is failed. Use this to display a specific message to users rather than a generic failure message.

tracking_domain_in_use — the link tracking subdomain is already claimed by another organization.

capabilities.tracking

object

आवश्यक

Branded open/click tracking domain. not_configured until a tracking domain is set. Tracked links are served over HTTPS once the CNAME verifies.

चाइल्ड एट्रिब्यूट दिखाएँ

capabilities.tracking.status

string

आवश्यक

Capability verification status.

pending — verification has not run, or is currently running. - verified — all DNS records for this capability resolved with the expected values.
warning — a record for this capability verified before and a recent check no longer matches, but it is still within the grace period. Sending is not yet affected; fix it before the grace period ends.
failed — DNS records resolved but at least one value is wrong. Update your DNS to recover.
temporary_failure — DNS lookup failed transiently. Verification is queued for retry; don't change DNS records yet.
not_configured — the capability is not set up on this domain (e.g. no tracking domain configured).

Possible values: pending, verified, warning, failed, temporary_failure, not_configured

capabilities.tracking.domain

nullable string

Hostname this capability is configured with — the return-path domain, the tracking domain, or the domain where the DMARC policy was found. Null when not applicable or not configured.

capabilities.tracking.pending

object

चाइल्ड एट्रिब्यूट दिखाएँ

capabilities.tracking.pending.domain

string

आवश्यक

Hostname the capability will use once the staged change verifies.

capabilities.tracking.pending.status

string

आवश्यक

Possible values: pending, failed, temporary_failure

capabilities.tracking.reason

nullable string

Machine-readable reason code for a failed capability status. Only set when status is failed. Use this to display a specific message to users rather than a generic failure message.

tracking_domain_in_use — the link tracking subdomain is already claimed by another organization.

capabilities.inbound

object

Inbound mail receiving. not_configured until receiving is enabled on this domain (see DomainUpdate.inbound), then pending while the published MX records are checked, and verified once they resolve to Bird. The MX records to publish are always listed under dns_records (purpose: inbound_mx) as a regional reference, even while this is not_configured — enabling is what actually starts delivery.

चाइल्ड एट्रिब्यूट दिखाएँ

capabilities.inbound.status

string

आवश्यक

Capability verification status.

pending — verification has not run, or is currently running. - verified — all DNS records for this capability resolved with the expected values.
warning — a record for this capability verified before and a recent check no longer matches, but it is still within the grace period. Sending is not yet affected; fix it before the grace period ends.
failed — DNS records resolved but at least one value is wrong. Update your DNS to recover.
temporary_failure — DNS lookup failed transiently. Verification is queued for retry; don't change DNS records yet.
not_configured — the capability is not set up on this domain (e.g. no tracking domain configured).

Possible values: pending, verified, warning, failed, temporary_failure, not_configured

capabilities.inbound.domain

nullable string

Hostname this capability is configured with — the return-path domain, the tracking domain, or the domain where the DMARC policy was found. Null when not applicable or not configured.

capabilities.inbound.pending

object

चाइल्ड एट्रिब्यूट दिखाएँ

capabilities.inbound.pending.domain

string

आवश्यक

Hostname the capability will use once the staged change verifies.

capabilities.inbound.pending.status

string

आवश्यक

Possible values: pending, failed, temporary_failure

capabilities.inbound.reason

nullable string

Machine-readable reason code for a failed capability status. Only set when status is failed. Use this to display a specific message to users rather than a generic failure message.

tracking_domain_in_use — the link tracking subdomain is already claimed by another organization.

dns_records

array of object

आवश्यक

The domain's DNS records and their individual verification state, returned in full on both the list and single-domain responses. This is the complete set to publish across DKIM, return-path, DMARC, tracking, and inbound; records for a staged change carry state: pending. Inbound MX records are always included as a regional reference, even while receiving is off (capabilities.inbound.status is not_configured) — their presence alone does not mean receiving is enabled (see DomainUpdate.inbound).

चाइल्ड एट्रिब्यूट दिखाएँ

dns_records.type

string

आवश्यक

Possible values: TXT, CNAME, MX

dns_records.name

string

आवश्यक

The record name — the part you enter in your DNS provider's "Name" or "Host" field, relative to the DNS zone the record belongs in (your registered domain). For a sending domain mail.acme.com the DKIM record name is bird1._domainkey.mail, entered in the acme.com zone. @ for records at the zone apex.

dns_records.host

string

आवश्यक

The fully qualified hostname for this record (e.g. bird1._domainkey.mail.acme.com).

dns_records.value

string

आवश्यक

The value to publish, as entered in your DNS provider's "Value" or "Content" field: the full record content for TXT, the target hostname for CNAME, and the priority followed by the mail server hostname for MX.

dns_records.purpose

string

आवश्यक

What this record is for.

dkim — signs outbound mail and proves domain ownership. - return_path — return-path (bounce) CNAME for sending. - tracking — branded open/click tracking CNAME (optional). - dmarc — advisory DMARC policy record. - inbound_mx — MX record routing mail to Bird for receiving. Always present wherever inbound is available, as a regional reference, regardless of whether receiving is enabled; publishing it does not enable receiving on its own — see DomainUpdate.inbound.

Possible values: dkim, return_path, tracking, inbound_mx, dmarc

dns_records.state

string

आवश्यक

Lifecycle state of this record.

active — the record backs the domain's current configuration. - pending — the record belongs to a staged configuration change; publish it to complete the change.
deprecated — the record belonged to a previous configuration. Keep it in DNS until safe_to_remove is true; in-flight mail and previously sent tracked links may still resolve through it.

Possible values: active, pending, deprecated

dns_records.optional

boolean

आवश्यक

Whether this record can be skipped. Optional records enable extra functionality (e.g. tracking) but are not required for sending.

dns_records.status

string

आवश्यक

Verification status of this record's most recent DNS check.

pending — the record has not verified yet; publish it (or correct it) and it will verify on the next check.
verified — the most recent check matched the expected value. - warning — the record verified before and a recent check no longer matched, but it is still within the grace period. Sending is not yet affected; fix the record before the grace period ends to avoid it being blocked.
failed — the record verified before but later checks kept failing past the grace period; the configuration has regressed and needs attention.

Possible values: pending, verified, warning, failed

dns_records.error

nullable string

Human-readable detail for a failed check on this record — what was found in DNS and why it did not match. Null when the record is verified or not yet checked.

dns_records.safe_to_remove

nullable boolean

Only set on deprecated records: true once the record is no longer referenced by in-flight mail or live tracked links and can be deleted from your DNS. Null on active and pending records.

last_checked_at

nullable string

When Bird last checked this domain's DNS records, whether or not the outcome changed. Updated on every verification — your manual refresh and the periodic automatic re-checks alike. Null if the domain has never been checked.

verified_at

nullable string

When the domain's ownership was confirmed — the moment status became verified via the DKIM record. Unchanged by later re-checks while it stays verified. Null if the domain has never been verified.

created_at

string

आवश्यक

When the domain was added.

updated_at

string

आवश्यक

When the domain's configuration was last changed (such as a settings or return-path change). Verification re-checks do not change this; see last_checked_at and verified_at for verification timing.

bird email domains create mail.acme.com