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 Subscribers API

The Subscribers API from Buttondown — 12 operation(s) covering subscriber lifecycle — creation, updates, tags, referrals, automations and Stripe subscriptions.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 12 operations across 9 paths, and defines 31 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.

12 operations 9 paths 31 schemas 1 DELETE5 GET2 PATCH4 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 Subscribers 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 12

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

Subscribers 12
POST
/subscribers
Create Subscriber
create_subscriber 2 params body → 201400403409422429401
GET
/subscribers
List Subscribers
list_subscribers 48 params → 200400403404422409401429
GET
/subscribers/{id_or_email}
Retrieve Subscriber
retrieve_subscriber 2 params → 200403404409401429
DELETE
/subscribers/{id_or_email}
Delete Subscriber
delete_subscriber 1 param → 204403404409401429
PATCH
/subscribers/{id_or_email}
Update Subscriber
update_subscriber 1 param body → 200400403404409422401429
POST
/subscribers/{id_or_email}/send-reminder
Send Reminder
send_reminder 1 param → 200403404409401429
POST
/subscribers/{id_or_email}/send-magic-link
Send Magic Link To Subscriber
send_magic_link_to_subscriber 1 param → 200403404409401429
POST
/subscribers/{id_or_email}/emails/{email_id}
Send Email To
send_email_to 2 params → 200400403404409401429
GET
/subscribers/{id_or_email}/referrals
Get Referrals
get_referrals 2 params → 200403404409401429
GET
/subscribers/{id_or_email}/automations
Get Automations
get_automations 2 params → 200403404409401429
PATCH
/subscribers/{id_or_email}/automations/{automation_attempt_id}
Update Automation Attempt
update_automation_attempt 2 params body → 200400403404409401429
GET
/subscribers/{id_or_email}/stripe-subscriptions
Get Stripe Subscriptions
get_stripe_subscriptions 2 params → 200403404409401429

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Subscriber (47 properties), SubscriberInput (11 properties), StripeSubscription (11 properties), SubscriberUpdateInput (9 properties). Each schema is shown below with its type and property counts.

AutomationAttemptUpdateInput
object
1 property 1 required
StripeSubscription
object
11 properties 6 required
UpdateAutomationAttemptErrorCode
string
Represents the type of error that occurred when updating an automation attempt. Human-readable error messages are provided in the detail field of the response;…
AutomationAttemptStatus
string
An enumeration.
UpdateSubscriberErrorCode
string
Represents the type of error that occurred when updating a subscriber. Human-readable error messages are provided in the detail field of the response; these va…
SubscriberUpdateInput
object
9 properties
Empty
object
SubscriberInputValidationErrorCode
string
Represents the type of error that occurred when validating subscriber input. Human-readable error messages are provided in the detail field of the response; th…
ErrorMessage_ValidationErrorCode_
object
3 properties 1 required
ValidationErrorMessage
object
1 property 1 required
ErrorMessage_UpdateSubscriberErrorCode_
object
3 properties 1 required
FirewallReasonCode
string
An enumeration.
AutomationForSubscriberPage
object
4 properties 2 required
Subscriber
object
Subscribers are the main way you collect email addresses and recipients on Buttondown. They're what you see on your [subscribers page](https://buttondown.com/s…
47 properties 11 required
FirewallReason
object
2 properties 2 required
Transition
object
2 properties 2 required
SubscriberType
string
Represents the state of a subscriber and what emails they should or should not be receiving. This type is meant to be fully expressive so as to consolidate the…
ListSubscribersErrorCode
string
Represents the type of error that occurred when listing subscribers. Human-readable error messages are provided in the detail field of the response; these valu…
CollisionBehavior
string
An enumeration.
ErrorMessage_UpdateAutomationAttemptErrorCode_
object
3 properties 1 required
SubscriberInput
object
11 properties 1 required
ValidationErrorDetail
object
3 properties 3 required
StripeCoupon
object
Coupons let you offer discounts to subscribers who pay for your newsletter. Buttondown's coupons are backed by Stripe, so each coupon maps to a coupon on your…
4 properties 1 required
EmailTransition
object
3 properties 2 required
AutomationForSubscriber
object
6 properties 6 required
ErrorMessage_ListSubscribersErrorCode_
object
3 properties 1 required
StripeSubscriptionPage
object
4 properties 2 required
SubscriberUndeliverabilityReason
string
The reason Buttondown has marked the subscriber as undeliverable. Undeliverable subscribers are not sent emails, and may be periodically removed from the syste…
SubscriberSource
string
Represents the original provenance of a subscriber. This value is not exposed to subscribers; it's only used for internal tracking purposes and governs some of…
SubscriberPage
object
4 properties 2 required
ErrorMessage
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

buttondown-subscribers-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
#Subscribers
← Back to B APIs
API Details
ID
buttondown:buttondown-subscribers-api
Base URL
https://api.buttondown.com/v1
Docs
https://docs.buttondown.com/api-subscribers-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-subscribers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/buttondown-subscribers-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 Subscribers 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.