{
  "opencollection": "1.0.0",
  "info": {
    "name": "Buttondown Newsletters API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Newsletters",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Newsletters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.buttondown.com/v1/newsletters",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page number of the paginated response."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "List all newsletters"
        },
        {
          "info": {
            "name": "Create Newsletter",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.buttondown.com/v1/newsletters",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Create a new newsletter"
        },
        {
          "info": {
            "name": "Retrieve Newsletter",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.buttondown.com/v1/newsletters/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve a specific newsletter by its ID"
        },
        {
          "info": {
            "name": "Update Newsletter",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.buttondown.com/v1/newsletters/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Update a newsletter's settings"
        },
        {
          "info": {
            "name": "Delete Newsletter",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.buttondown.com/v1/newsletters/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Delete a newsletter"
        },
        {
          "info": {
            "name": "Retrieve Sending Domain",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.buttondown.com/v1/newsletters/:id/sending-domain",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "force",
                "value": "",
                "type": "query",
                "description": "When true, trigger a fresh DNS re-verification instead of serving the last-known record."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Retrieve Hosting Domain",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.buttondown.com/v1/newsletters/:id/hosting-domain",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve the DNS verification status for a newsletter's custom hosting domain. This synchronously re-verifies the domain's DNS records."
        }
      ]
    }
  ],
  "bundled": true
}