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

The Automations API from Buttondown — 7 operation(s) covering triggered and scheduled email sequences, their actions, timing and analytics.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Automations. 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 23 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 23 schemas 1 DELETE3 GET1 PATCH2 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 Automations 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, 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Automations 7
GET
/automations
List Automations
list_automations 1 param → 200400403409401429
POST
/automations
Create Automation
create_automation body → 201400403409422401429
GET
/automations/{id}
Retrieve Automation
retrieve_automation 1 param → 200403404409401429
PATCH
/automations/{id}
Update Automation
update_automation 1 param body → 200400403404409422401429
DELETE
/automations/{id}
Delete Automation
delete_automation 1 param → 204403404409401429
POST
/automations/{id}/invoke
Invoke Automation
invoke_automation 1 param → 200400403404409401429
GET
/automations/{id}/analytics
Retrieve Automation Analytics
retrieve_automation_analytics 1 param → 200403404409401429

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Analytics (20 properties), Automation (9 properties), AutomationUpdateInput (8 properties), AutomationInput (6 properties). Each schema is shown below with its type and property counts.

FilterGroup
object
Buttondown's filtering schema can be used for multiple things: - Filtering [the audience of an email](/api-emails-create) to a specific subset - Creating [fine…
3 properties 3 required
ErrorMessage_AutomationCreationErrorCode_
object
3 properties 1 required
AutomationStatus
string
An enumeration.
Filter
object
A filter is a single condition that can be evaluated against a [Subscriber](/api-subscribers-retrieve). It has a field, an operator, and a value: json { "field…
3 properties 3 required
Action
object
An action to perform when the automation's trigger fires.
3 properties 2 required
ValidationErrorMessage
object
1 property 1 required
Operator
string
An enumeration.
ActionInput
object
Request payload for an action to perform when the automation's trigger fires.
3 properties 1 required
DelayInput
object
Request payload configuration for delaying an automation action.
3 properties 2 required
FailureBreakdownItem
object
A single failure reason with its count.
2 properties 2 required
Delay
object
Configuration for how long to wait before executing the automation's action.
3 properties 2 required
Analytics
object
20 properties
AutomationInput
object
6 properties 3 required
TimingInput
object
Request payload controls for when an automation action executes.
2 properties 1 required
Timing
object
Controls when an automation's action executes after the trigger fires.
2 properties 1 required
ValidationErrorDetail
object
3 properties 3 required
AutomationActionType
string
The action that is triggered when the automation is successfully run.
AutomationPage
object
4 properties 2 required
AutomationUpdateInput
object
8 properties
AutomationCreationErrorCode
string
Represents the type of error that occurred when creating an automation. Human-readable error messages are provided in the detail field of the response; these v…
ExternalEventType
string
Various types of events that are recorded by Buttondown, both in terms of exogenous systems like Stripe and Memberful, and endogenous ones like email opens and…
Automation
object
A rule that automatically performs actions in response to events.
9 properties 9 required
ErrorMessage
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

buttondown-automations-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 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
Buttondown External Feeds API
AE Profile APIs.io
#Automations
← Back to B APIs
API Details
ID
buttondown:buttondown-automations-api
Base URL
https://api.buttondown.com/v1
Docs
https://docs.buttondown.com/api-automation-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-automations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/buttondown-automations-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 Automations 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.