Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Update a domain

PATCH/domains/{id}
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
idstring<uuid>required
Request body
application/json
click_trackingboolean

Rewrite links to redirect through the tracking host and record email.clicked events. Off by default.

open_trackingboolean

Inject a tracking pixel served from the tracking host and record email.opened events. Off by default.

tracking_subdomainstring | null

DNS label of the domain's own tracking host, e.g. "links" for links.<domain>. Optional: without one, tracked links use the shared tracking host. Setting it adds a Tracking CNAME to records[] (point it at the given value, DNS only); its certificate is issued automatically once it resolves, the Tracking record then reads verified, and links go through it from then on. A subdomain that does not activate within 72 hours reads failed; send the same tracking_subdomain again to retry. Empty string or null clears it.

unsubscribe_subdomainstring | null

BillionSend extension: DNS label of the domain's own unsubscribe host, e.g. "unsubscribe" for unsubscribe.<domain>. Optional: without one, unsubscribe links (and the List-Unsubscribe header) use the shared unsubscribe host. Setting it adds an Unsubscribe CNAME to records[] (point it at the given value, DNS only); its certificate is issued automatically once it resolves, the Unsubscribe record then reads verified, and unsubscribe links go through it from then on. The same label as tracking_subdomain is allowed: one host then serves both and records[] shows one row. A subdomain that does not activate within 72 hours reads failed; send the same unsubscribe_subdomain again to retry. Kept apart from tracking_subdomain because ad blockers filter tracking hosts by name. Empty string or null clears it.

unsubscribe_pageobject

BillionSend extension: this domain's own look for its unsubscribe pages. Fields not sent keep their value; null clears one, and a cleared field falls back to the team's default page. logo_url is read-only here: the logo is uploaded in the dashboard.

Show properties
brand_namestring | null

Name shown on the page; max 80 characters

max length 80
messagestring | null

Text above the unsubscribe button; max 500 characters

max length 500
success_messagestring | null

Text shown once the choice is saved; max 500 characters

max length 500
redirect_urlstring | null

Where the recipient goes after unsubscribing instead of the in-page message; http(s) only

background_colorstring | null

Page background, #rrggbb

text_colorstring | null

Page text color, #rrggbb

accent_colorstring | null

Button and link color, #rrggbb

logo_radiusstring | null

Corner radius of the logo: square, gentle, rounded or circle

Allowed:squaregentleroundedcirclenull
tlsany
capabilitiesobject

What the domain is used for (sending, receiving); omitted fields keep their value.

Show properties
sendingstring

Only enabled is accepted: a domain of your own can't be receive-only, so disabled is a 422.

Allowed:enableddisabled
receivingstring

Inbound mail for every address at the domain (a catch-all), readable at /emails/receiving and announced by the email.received webhook. Enabling needs a verified domain on an instance that receives mail, and adds a Receiving MX record to records[]. A domain that already has mailboxes is best received on a subdomain (inbound.example.com): the Receiving MX would take their mail.

Allowed:enableddisabled
receiving_catch_allboolean

BillionSend extension: store mail to addresses without an inbox (true) or refuse it at RCPT (false). Turning it on needs receiving enabled and, on BillionSend Cloud, a paid plan.

Responses
200

Domain updated; full object with records

idstring<uuid>required
namestringrequired
statusstringrequired
created_atstringrequired
regionstringrequired
open_trackingbooleanrequired
click_trackingbooleanrequired
tracking_subdomainstring | nullrequired
tracking_statusstring | nullrequired

BillionSend extension: where the tracking subdomain stands: pending (waiting for its CNAME and certificate), active (links go through it) or failed (did not activate within 72 hours; links use the shared host). null while no tracking_subdomain is set.

Allowed:pendingactivefailednull
tracking_errorstring | nullrequired

BillionSend extension: why the tracking subdomain is not active, when known

unsubscribe_subdomainstring | nullrequired

BillionSend extension: the domain's own unsubscribe host label, null when unset

unsubscribe_statusstring | nullrequired

BillionSend extension: where the unsubscribe subdomain stands: pending, active (unsubscribe links go through it) or failed (links use the shared host). null while no unsubscribe_subdomain is set. When both subdomains are the same label they share one host and always read the same.

Allowed:pendingactivefailednull
unsubscribe_errorstring | nullrequired

BillionSend extension: why the unsubscribe subdomain is not active, when known

unsubscribe_pageobjectrequired

BillionSend extension: this domain's own look for its unsubscribe pages. A null field falls back to the team's default page, then to the built-in default.

Show properties
brand_namestring | nullrequired
messagestring | nullrequired
success_messagestring | nullrequired
redirect_urlstring | nullrequired
background_colorstring | nullrequired
text_colorstring | nullrequired
accent_colorstring | nullrequired
logo_radiusstring | nullrequired
Allowed:squaregentleroundedcirclenull
logo_urlstring | nullrequired

Read-only; uploaded in the dashboard

capabilitiesobjectrequired
Show properties
sendingstringrequired

enabled; on the shared row, disabled while the instance pauses sending from the shared domain

receivingstringrequired

enabled while the domain receives mail; always disabled on an instance that does not

receiving_catch_allbooleanrequired

BillionSend extension: whether mail to an address without an inbox is stored (true) or refused at RCPT (false)

sharedbooleanrequired

BillionSend extension: true on the team's subdomain of the shared inbox domain, a read-only row listed after the team's own domains (403 on changes) that POST /inboxes domain_id takes; false on the team's own domains

sending_modestring

BillionSend extension, on the shared row only: what its inboxes' addresses may send. open starts conversations, reply_only replies inside their threads, receive_only sends nothing. Holds on names still apply per send: an address whose username or from_name imitates a brand, or one on an older label that does, replies only, even when the mode is open.

Allowed:openreply_onlyreceive_only
sending_mode_reasonstring | null

BillionSend extension, on the shared row only: what holds sending below open: the team's plan or the instance; null when open

Allowed:planinstancenull
objectstringrequired
Allowed:domain
recordsobject[]required
Show properties
Array of object
recordstringrequired

Which record this is: DKIM, SPF (the MAIL FROM MX and TXT rows), DMARC, Tracking (the tracking subdomain's CNAME, present once a tracking subdomain is set), Unsubscribe (the unsubscribe subdomain's CNAME, present once an unsubscribe subdomain is set to a label other than the tracking one) or Receiving (the MX inbound mail needs, present while receiving is enabled; it reads verified only when it is among the domain's lowest-numbered MX records). Only the DKIM and SPF rows gate sending.

namestringrequired
typestringrequired
ttlstringrequired
statusstringrequired

not_started | pending | verified | failed. DKIM and SPF rows combine public DNS with the provider's verification: found in DNS but not yet confirmed reads pending, a different published value reads failed, no record reads not_started. DMARC reads verified when a policy covers the domain — its own or a parent domain's (see inherited_from) — and not_started when none does. Tracking and Unsubscribe read verified once their CNAME resolves and its certificate is issued, pending until then, and failed when it did not activate within 72 hours.

valuestringrequired
prioritynumber
livestring

What public DNS answers for this record right now: found, missing, mismatch (a different value is published) or unknown (the lookup did not conclude). Omitted when no live check ran (the create response).

Allowed:foundmissingmismatchunknown
detailstring

One sentence explaining a row that is not verified: found but awaiting the provider, the value that is published instead, no record at the name, or which parent DMARC policy covers the domain. Omitted when there is nothing to add.

inherited_fromstring

DMARC only: the _dmarc name whose policy covers this domain when it has no record of its own (RFC 7489 organizational-domain fallback).

policystring

DMARC only, alongside inherited_from: the inherited policy's p= value.

Allowed:nonequarantinereject
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

Catch-all receiving or an own tracking / unsubscribe subdomain needs a paid plan, or the team's subdomain of the shared domain, which is read-only

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found, or a domain other than the one the calling key is held to

statusCodenumberrequired
namestringrequired
messagestringrequired
409

Another team receives mail for this domain

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X PATCH 'https://api.billionsend.com/domains/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "click_tracking": true,
  "open_tracking": true,
  "tracking_subdomain": "string",
  "unsubscribe_subdomain": "string",
  "unsubscribe_page": {
    "brand_name": "string",
    "message": "string",
    "success_message": "string",
    "redirect_url": "string",
    "background_color": "string",
    "text_color": "string",
    "accent_color": "string",
    "logo_radius": "square"
  },
  "tls": null,
  "capabilities": {
    "sending": "enabled",
    "receiving": "enabled"
  },
  "receiving_catch_all": true
}'
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "status": "string",
  "created_at": "string",
  "region": "string",
  "open_tracking": true,
  "click_tracking": true,
  "tracking_subdomain": "string",
  "tracking_status": "pending",
  "tracking_error": "string",
  "unsubscribe_subdomain": "string",
  "unsubscribe_status": "pending",
  "unsubscribe_error": "string",
  "unsubscribe_page": {
    "brand_name": "string",
    "message": "string",
    "success_message": "string",
    "redirect_url": "string",
    "background_color": "string",
    "text_color": "string",
    "accent_color": "string",
    "logo_radius": "square",
    "logo_url": "string"
  },
  "capabilities": {
    "sending": "string",
    "receiving": "string"
  },
  "receiving_catch_all": true,
  "shared": true,
  "sending_mode": "open",
  "sending_mode_reason": "plan",
  "object": "domain",
  "records": [
    {
      "record": "string",
      "name": "string",
      "type": "string",
      "ttl": "string",
      "status": "string",
      "value": "string",
      "priority": 0,
      "live": "found",
      "detail": "string",
      "inherited_from": "string",
      "policy": "none"
    }
  ]
}

Was this page helpful?