Buttondown logo

Retrieving a newsletter's sending domain

Sample requests

These sample requests are autogenerated by the OpenAPI spec. This endpoint requires one or more parameters in the URL: those are offset in curly-braces.

import requests

url = "https://api.buttondown.com/v1/newsletters/{id}/sending-domain"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}

response = requests.request("GET", url, headers=headers)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "id": "",
    "domain": "mail.example.com",
    "status": "valid",
    "warnings": [],
    "requirements": [
        {
            "record_type": "CNAME",
            "name": "pm-bounces.mail.example.com",
            "is_valid": true,
            "required_value": "pm.mtasv.net",
            "current_values": [
                "pm.mtasv.net"
            ],
            "context": "manual"
        },
        {
            "record_type": "TXT",
            "name": "pm._domainkey.mail.example.com",
            "is_valid": true,
            "required_value": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQ...",
            "current_values": [
                "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQ..."
            ],
            "context": "manual"
        }
    ],
    "existing_mail_provider": null,
    "detected_dns_provider": null,
    "checked_date": "2024-01-01T00:00:00Z",
    "is_checking": false
}

Path parameters

Consult the Filtering documentation for more information on how to filter and sort your requests.

force

Type
string
Description

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