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

Buttondown External Feeds API

The External Feeds API from Buttondown — 7 operation(s) covering RSS-to-email feeds, their polling cadence and the items they produce.

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

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

This API exposes 7 operations across 3 paths, and defines 29 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 3 paths 29 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
Resource Areas
1

Authentication & Security 1

Buttondown External Feeds 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 3 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.

External Feeds 7
POST
/external_feeds
Create External Feed
create_external_feed body → 201400403409422401429
GET
/external_feeds
List External Feed
list_external_feed 1 param → 200403409401429
PATCH
/external_feeds/{id}
Update External Feed
update_external_feed 1 param body → 200400403404409422401429
DELETE
/external_feeds/{id}
Delete External Feed
delete_external_feed 1 param → 204403404409401429
GET
/external_feeds/{id}
Retrieve External Feed
retrieve_external_feed 1 param → 200403404409401429
POST
/external_feeds/{id}/items
Poll Items
poll_items 1 param → 200403404409401429
GET
/external_feeds/{id}/items
Retrieve Items
retrieve_items 3 params → 200400403404409422401429

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Email (27 properties), Analytics (20 properties), ExternalFeed (14 properties), ExternalFeedItem (11 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
EmailCommentingMode
string
Governs who can comment on this email. This enum replaces the iscommentsdisabled field, which has been deprecated. (Also note that this field may be superseded…
ExternalFeedItem
object
An external feed item is a single item in an external RSS feed. It is created automatically by Buttondown when a new item is detected in an external feed. Exte…
11 properties 9 required
Empty
object
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
EmailStatus
string
Represents the state of an email. No action is required to move from one state or another; Buttondown internally handles the transitions, and exposing the stat…
ValidationErrorMessage
object
1 property 1 required
Operator
string
An enumeration.
Callout
string
Surfacing-time flags about an email that the UI uses to render contextual callouts (e.g. in the analytics panel). Computed on read; not persisted.
FailureBreakdownItem
object
A single failure reason with its count.
2 properties 2 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…
ArchivalMode
string
Governs who can view this email in the archive. ARCHIVEONLY is the odd one out: the email is publicly archived but is not email content at all (e.g. an importe…
CadenceMetadata
object
3 properties
ExternalFeedUpdateInput
object
10 properties
Analytics
object
20 properties
ExternalFeedInput
object
10 properties 6 required
ExternalFeedAutomationBehavior
string
An enumeration.
ExternalFeedItemPage
object
4 properties 2 required
EmailSource
string
Represents the original provenance of an email. This value is not exposed to subscribers, but does determine some behavior of the email (e.g. whether or not an…
Email
object
Emails are why you're here on Buttondown, right? Creating an email via the API is just like creating one in the interface; it will instantly trigger sending ac…
27 properties 17 required
ExternalFeed
object
An automation is a one-to-one mapping between an external RSS feed and an action to be performed when new items are detected in that feed. Right now, Buttondow…
14 properties 12 required
ValidationErrorDetail
object
3 properties 3 required
EmailSuppressionReason
string
Represents the reason an email was suppressed.
ExternalFeedAutomationCadence
string
An enumeration.
ExternalFeedPage
object
4 properties 2 required
EmailType
string
The legacy single-axis representation of an email's audience and archive visibility. No longer stored: filters owns the audience axis and archivalmode owns the…
ExternalFeedItemStatus
string
The status of a given item (meaning a distinct URL) within an RSS feed.
ExternalFeedAutomationStatus
string
Represents the status of the automation, and whether or not it is active. Inactive automations will not be processed. Deleted automations will not be processed.
ErrorMessage
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

buttondown-external-feeds-api-openapi.yml Raw ↑

Other APIs Buttondown publishes across the network.

Buttondown Accounts API
Buttondown Advertising Units API
Buttondown API Requests API
Buttondown Attachments API
Buttondown Automations API
Buttondown Books API
Buttondown Bulk Actions API
Buttondown Comments API
Buttondown Coupons API
Buttondown Emails API
Buttondown Events API
Buttondown Exports API
Where this information came from

This is an independent, third-party profile of Buttondown External Feeds 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.