List domains
Newest first, with cursor pagination: after takes the last id of a page and pages toward older items, before takes the first id and pages back toward newer ones. The team’s subdomain of the shared domain, when it has one, is the last row (shared: true).
/domainsAuthorizationBearer 令牌 · header必填A BillionSend API key (bs_…).
limitintegerPage size, 1-100 (default 20)
afterstring<uuid>Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.
beforestring<uuid>Cursor: id of the first item of the current page; returns the previous page; same rule as after.
Domains
objectstring必填listdataobject[]必填显示属性隐藏属性
object 数组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.
pendingactivefailednulltracking_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.
pendingactivefailednullunsubscribe_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必填squaregentleroundedcirclenulllogo_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_modestringBillionSend 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_onlysending_mode_reasonstring | nullBillionSend 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
planinstancenullhas_moreboolean必填Missing, malformed, unknown or revoked API key
statusCodenumber必填namestring必填messagestring必填Validation error
statusCodenumber必填namestring必填messagestring必填Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumber必填namestring必填messagestring必填