How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Buttondown

Buttondown Newsletters API

The Newsletters API from Buttondown — 7 operation(s) covering newsletter settings, branding, locale, and custom sending/hosting domain verification.

Documentation Provider Profile APIs.io OpenAPI GitHub

Buttondown Newsletters API is one of 31 APIs that Buttondown publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Newsletters. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 7 operations across 4 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.buttondown.com/v1.

7 operations 4 paths 22 schemas 1 DELETE4 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.buttondown.com/v1
Authentication
API Key
License
MIT
Resource Areas
1

Authentication & Security 1

Buttondown Newsletters API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key passed as 'Token ' in the Authorization header.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Newsletters 7
GET
/newsletters
List Newsletters
list_newsletters 1 param → 200400403409401429
POST
/newsletters
Create Newsletter
create_newsletter body → 201400403409422401429
GET
/newsletters/{id}
Retrieve Newsletter
retrieve_newsletter 1 param → 200403404409401429
PATCH
/newsletters/{id}
Update Newsletter
update_newsletter 1 param body → 200400403404409422401429
DELETE
/newsletters/{id}
Delete Newsletter
delete_newsletter 1 param → 204403404409401429
GET
/newsletters/{id}/sending-domain
Retrieve Sending Domain
retrieve_sending_domain 2 params → 200400403404409401429
GET
/newsletters/{id}/hosting-domain
Retrieve Hosting Domain
retrieve_hosting_domain 1 param → 200403404409401429

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Newsletter (62 properties), NewsletterUpdateInput (55 properties), NewsletterInput (33 properties), SendingDomainRecord (9 properties). Each schema is shown below with its type and property counts.

SendingDomainStatus
string
The DNS verification status of a newsletter's custom sending domain.
NewsletterUpdateInput
object
55 properties
NewsletterInput
object
33 properties 3 required
SocialAccountType
string
An enumeration.
CreateNewsletterErrorCode
string
Represents the type of error that occurred when creating a newsletter. Human-readable error messages are provided in the detail field of the response; these va…
Newsletter
object
You will likely not need to interact with your newsletter settings programmatically, but if you do, this is the endpoint for you. You can create, update, and l…
62 properties 6 required
HostingDomainRecord
object
6 properties 4 required
ValidationErrorMessage
object
1 property 1 required
RequirementRecord
object
6 properties 6 required
NewsletterEmailTemplate
string
Represents the template of an email. Each template has a different layout/style; you can view screenshots and examples [in the docs](https://docs.buttondown.co…
NewsletterArchiveTheme
string
An enumeration.
NewsletterLocale
string
An enumeration.
NewsletterAuditingMode
string
An enumeration.
NewsletterAnnouncementBarVisibility
string
An enumeration.
SendingDomainRecord
object
9 properties 5 required
ValidationErrorDetail
object
3 properties 3 required
ErrorMessage_CreateNewsletterErrorCode_
object
3 properties 1 required
ApexAliasProvider
object
9 properties 7 required
HostingDomainStatus
string
The DNS verification status of a newsletter's custom hosting domain.
NewsletterPage
object
4 properties 2 required
SocialAccountSchema
object
3 properties 2 required
ErrorMessage
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

buttondown-newsletters-api-openapi.yml Raw ↑

Other APIs Buttondown publishes across the network.

Buttondown Accounts API
AE Profile APIs.io
Buttondown Advertising Units API
AE Profile APIs.io
Buttondown API Requests API
AE Profile APIs.io
Buttondown Attachments API
AE Profile APIs.io
Buttondown Automations API
AE Profile APIs.io
Buttondown Books API
AE Profile APIs.io
Buttondown Bulk Actions API
AE Profile APIs.io
Buttondown Comments API
AE Profile APIs.io
Buttondown Coupons API
AE Profile APIs.io
Buttondown Emails API
AE Profile APIs.io
Buttondown Events API
AE Profile APIs.io
Buttondown Exports API
AE Profile APIs.io
#Newsletters
← Back to B APIs
API Details
ID
buttondown:buttondown-newsletters-api
Base URL
https://api.buttondown.com/v1
Docs
https://docs.buttondown.com/api-newsletters-introduction
Provider
Buttondown
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=buttondown-newsletters-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/buttondown-newsletters-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Buttondown Newsletters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.