Share a domain's DNS records by email

POST

/v1/email/domains/{domain_id}/dns-records/share

curl -X POST "https://us1.platform.bird.com/v1/email/domains/{domain_id}/dns-records/share" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": [
      "alice@example.com",
      "bob@example.com"
    ]
  }'

Emails the domain's current DNS records to up to three recipients, so a colleague who manages your DNS can publish them without a Bird account. One email is sent: the first recipient receives it directly and the rest are copied. It lists each record's type, name, value, and current verification status, and names who requested it.

An invalid recipient address, or none, returns 422. Rate limited per user (default 5 calls per hour); further calls return 429.

Parameters

domain_id

string

Domain ID.

Verzoekpayload

emails

array of string

verplicht

Email recipients for the domain's current DNS records. The first address is the direct recipient and the rest are copied on the same email; duplicates are ignored. Any invalid address fails the whole request with 422.

curl -X POST "https://us1.platform.bird.com/v1/email/domains/{domain_id}/dns-records/share" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": [
      "alice@example.com",
      "bob@example.com"
    ]
  }'