Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Retrieve a domain

GET/domains/{id}
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
idstring<uuid>obrigatório
Respostas
200

Domain with its DNS records; the team's shared subdomain has none (records: [])

idstring<uuid>obrigatório
namestringobrigatório
statusstringobrigatório
created_atstringobrigatório
regionstringobrigatório
open_trackingbooleanobrigatório
click_trackingbooleanobrigatório
tracking_subdomainstring | nullobrigatório
tracking_statusstring | nullobrigatório

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.

Valores permitidos:pendingactivefailednull
tracking_errorstring | nullobrigatório

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

unsubscribe_subdomainstring | nullobrigatório

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

unsubscribe_statusstring | nullobrigatório

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.

Valores permitidos:pendingactivefailednull
unsubscribe_errorstring | nullobrigatório

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

unsubscribe_pageobjectobrigatório

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.

Mostrar propriedades
brand_namestring | nullobrigatório
messagestring | nullobrigatório
success_messagestring | nullobrigatório
redirect_urlstring | nullobrigatório
background_colorstring | nullobrigatório
text_colorstring | nullobrigatório
accent_colorstring | nullobrigatório
logo_radiusstring | nullobrigatório
Valores permitidos:squaregentleroundedcirclenull
logo_urlstring | nullobrigatório

Read-only; uploaded in the dashboard

capabilitiesobjectobrigatório
Mostrar propriedades
sendingstringobrigatório

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

receivingstringobrigatório

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

receiving_catch_allbooleanobrigatório

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

sharedbooleanobrigatório

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.

Valores permitidos: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

Valores permitidos:planinstancenull
objectstringobrigatório
Valores permitidos:domain
recordsobject[]obrigatório
Mostrar propriedades
Array de object
recordstringobrigatório

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.

namestringobrigatório
typestringobrigatório
ttlstringobrigatório
statusstringobrigatório

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.

valuestringobrigatório
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).

Valores permitidos: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.

Valores permitidos:nonequarantinereject
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Requisição
curl -X GET 'https://api.billionsend.com/domains/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "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"
    }
  ]
}

Esta página foi útil?