跳到内容
Esc
↑↓导航↵打开⌘J预览

Create a domain

POST/domains
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

请求体
必填application/json
namestring必填
regionstring

SES region of the identity, one of the regions this deployment serves (the values listed here; the first is the default). Any other region is rejected with 422. A domain has one region, fixed when it is added.

允许值:us-east-1eu-west-1sa-east-1ap-northeast-1
custom_return_pathstring
默认值:"send"
open_trackingboolean

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

click_trackingboolean

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

tracking_subdomainstring

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.

unsubscribe_subdomainstring

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.

capabilitiesobject

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

显示属性
sendingstring

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

允许值: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, 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.

允许值:enableddisabled
响应
200

Domain created

idstring<uuid>必填
namestring必填
statusstring必填
created_atstring必填
regionstring必填
open_trackingboolean必填
click_trackingboolean必填
tracking_subdomainstring | null必填
tracking_statusstring | null必填

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.

允许值:pendingactivefailednull
tracking_errorstring | null必填

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

unsubscribe_subdomainstring | null必填

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

unsubscribe_statusstring | null必填

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.

允许值:pendingactivefailednull
unsubscribe_errorstring | null必填

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

unsubscribe_pageobject必填

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.

显示属性
brand_namestring | null必填
messagestring | null必填
success_messagestring | null必填
redirect_urlstring | null必填
background_colorstring | null必填
text_colorstring | null必填
accent_colorstring | null必填
logo_radiusstring | null必填
允许值:squaregentleroundedcirclenull
logo_urlstring | null必填

Read-only; uploaded in the dashboard

capabilitiesobject必填
显示属性
sendingstring必填

enabled; on the shared row, disabled while sending from the shared domain is paused

receivingstring必填

enabled while the domain receives mail

receiving_catch_allboolean必填

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

sharedboolean必填

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.

允许值:openreply_onlyreceive_only
sending_mode_reasonstring | null

BillionSend extension, on the shared row only: what holds sending below open: plan when the team's plan holds it, the other value when the platform's sending switches do; null when open

允许值:planinstancenull
recordsobject[]必填
显示属性
object 数组
recordstring必填

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.

namestring必填
typestring必填
ttlstring必填
statusstring必填

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.

valuestring必填
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).

允许值: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.

允许值:nonequarantinereject
401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
403

Plan domain limit reached, an own tracking or unsubscribe subdomain needs a paid plan, or the key is held to one domain (it cannot create domains)

statusCodenumber必填
namestring必填
messagestring必填
409

Domain already added

statusCodenumber必填
namestring必填
messagestring必填
422

Validation error

statusCodenumber必填
namestring必填
messagestring必填
429

Too many domains created recently, or the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
请求体application/json
请求
curl -X POST 'https://api.billionsend.com/domains' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "region": "us-east-1",
  "custom_return_path": "send",
  "open_tracking": true,
  "click_tracking": true,
  "tracking_subdomain": "string",
  "unsubscribe_subdomain": "string",
  "capabilities": {
    "sending": "enabled",
    "receiving": "enabled"
  }
}'
响应
{
  "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",
  "records": [
    {
      "record": "string",
      "name": "string",
      "type": "string",
      "ttl": "string",
      "status": "string",
      "value": "string",
      "priority": 0,
      "live": "found",
      "detail": "string",
      "inherited_from": "string",
      "policy": "none"
    }
  ]
}

这个页面有帮助吗?