BUbuttondown
Newsletters

Retrieve Sending Domain

Changed on

Retrieve the DNS verification status and required records for a newsletter's custom sending domain. While is_checking is true, a background re-verification is in flight; poll until it flips to false. Pass force=true to trigger a re-check.

get/newsletters/{id}/sending-domain

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/newsletters/{id}/sending-domain
  • Auth
    API key in header Authorization

Path parameters

idstring required

Query parameters

forceboolean

When true, trigger a fresh DNS re-verification instead of serving the last-known record.

Response

OK

idstring required

The ESP-side identifier for the domain, when available.

domainstring required

The custom sending domain being verified.

status'none' | 'invalid' | 'awaiting_ssl' | 'failing' | 'deliberately_cold' | 'valid' required

The DNS verification status of a newsletter's custom sending domain.

existing_mail_providerstring nullable

The third-party mail provider already handling this domain's inbound mail, when detected; its MX record is then omitted from requirements.

checked_datestring date-time nullable

When the record was last computed. Null until the first verification completes.

is_checkingboolean

Whether a background re-verification is currently in flight. Clients poll while this is true.

Changes

  • 0b8842d5bd7fRevision changes
    • info

      added the optional property //// to the response with the status

  • ec416fed83e9Revision changes
    • info

      added the optional property // to the response with the status