Update a sending domain
/v1/email/domains/{domain_id}await bird.domains.update("dom_01krdgeqcxet5s7t44vh8rt9mg", {
settings: { click_tracking: true, open_tracking: true },
tracking: { name: "links" },
});domain = client.domains.update(
"dom_01krdgeqcxet5s7t44vh8rt9mg",
settings={"click_tracking": True, "open_tracking": True},
tracking={"name": "links"},
)
print(domain.id)domain, err := client.Domains.Update(context.Background(), "dom_123", bird.DomainUpdateParams{
Settings: &bird.DomainSettings{ClickTracking: bird.Bool(true), OpenTracking: bird.Bool(true)},
Tracking: bird.Value(bird.DomainTrackingConfig{Name: "links"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Println(domain.Id)$bird->domains->update(
'dom_01krdgeqcxet5s7t44vh8rt9mg',
(new DomainUpdate())
->setSettings((new DomainSettings())->setClickTracking(true)->setOpenTracking(true))
->setTracking((new DomainUpdateTracking())->setName('links')),
);bird email domains update <domain-id> --body-file - <<'JSON'
{
"settings": {
"click_tracking": true,
"open_tracking": true
},
"tracking": {
"name": "links"
}
}
JSONcurl -X PATCH "https://us1.platform.bird.com/v1/email/domains/{domain_id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"settings": {
"click_tracking": true,
"open_tracking": true
},
"tracking": {
"name": "links"
}
}'{
"id": "dom_01krdgeqcxet5s7t44vh8rt9mg",
"workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
"domain": "mail.acme.com",
"vendor": "other",
"status": "pending",
"next": [
{
"kind": "operation"
}
],
"dkim": {
"mode": "txt",
"selector": "bird1",
"key_size": 2048
},
"capabilities": {
"sending": {
"status": "verified",
"pending": {
"domain": "rp.mail.acme.com",
"status": "pending"
}
},
"return_path": {
"status": "verified",
"pending": {
"domain": "rp.mail.acme.com",
"status": "pending"
}
},
"dmarc": {
"status": "verified",
"pending": {
"domain": "rp.mail.acme.com",
"status": "pending"
}
},
"tracking": {
"status": "verified",
"pending": {
"domain": "rp.mail.acme.com",
"status": "pending"
}
},
"inbound": {
"status": "verified",
"pending": {
"domain": "rp.mail.acme.com",
"status": "pending"
}
}
},
"dns_records": [
{
"type": "TXT",
"purpose": "dkim",
"state": "active",
"status": "pending"
}
]
}
Updates settings and configuration on a sending domain. settings
changes apply immediately. Changes to return_path, tracking, or
dkim on a verified capability are staged: the current configuration
keeps serving until the new one's DNS records verify, then the change
is promoted automatically. Staged values are visible under
capabilities.*.pending. The records to publish appear in
dns_records with state: pending.
Invalid combinations are rejected. Enabling tracking toggles without a
tracking domain, or removing the tracking domain while a toggle is on,
returns 409. Enabling inbound receiving has verification
prerequisites that return 422. Each rule is detailed on its field.
参数
domain_idstringID of the domain to update.
请求载荷
settingsPer-domain behavior toggles. Changes apply immediately to new sends.
显示子参数
settings.click_trackingRewrite 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_trackingInsert 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.
return_pathChange the return-path name part. Cannot be removed: the return-path is required for sending.
trackingSet or change the tracking name part, or remove tracking by passing null. Removal requires click_tracking and open_tracking to be disabled first, and returns 409 otherwise. After removal, links in previously sent email keep resolving while the tracking records are reported as deprecated.
dkimChange how the DKIM key is published. The current key keeps signing until the new configuration verifies, so mail is never sent unsigned during the transition.
inboundEnable or disable receiving on this domain. Enabling claims the domain for inbound and moves capabilities.inbound.status from not_configured to pending, then verified once the MX records resolve to us. The MX records to publish are always present under dns_records (purpose: inbound_mx) as a regional reference. Their presence does not mean receiving is enabled; enable the domain whenever capabilities.inbound.status is not_configured. Enabling requires the domain's DKIM to be verified first. A fresh enable on a domain whose DKIM is not verified returns 422 with E05019 and claims nothing. A domain already receiving inbound for another organization returns 422 with E05018.
响应载荷
idworkspace_iddomainThe sending domain name. Set at creation and immutable.
vendorThe 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
statusDomain 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, such as from a timeout or unreachable nameserver. Verification retries automatically; do not change the DNS records unless they are incorrect.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
nextWhat to do next about this domain, given the state it is in. Each entry names one action and says why it is worth taking, so you can act on this response without working out the order yourself. Present on reads that compute it: an empty list means there is nothing to do, and the field is absent entirely on responses that do not report next actions.
This answers whether you own the domain, which is what status reports. What each
capability still needs before it can send or receive is reported separately under
capabilities, so an empty list here does not on its own mean the domain is ready.
capabilitiesdns_recordsThe 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 and capabilities.inbound.status is not_configured. Their presence alone does not mean receiving is enabled; see DomainUpdate.inbound.
last_checked_atWhen we 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_atWhen 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_atWhen the domain was added.
updated_atWhen 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.