Buttondown logo

IntroductionStatusesCadencesBehaviorsItem Statuses

Routes

Listing external feedsCreating an external feedUpdating an external feedDeleting an external feedRetrieving an external feedListing external feed itemsCreating an external feed item

Buttondown logo

Updating an external feed

Sample requests

These sample requests are autogenerated by the OpenAPI spec. This endpoint requires one or more parameters in the URL: those are offset in curly-braces.

import requests

url = "https://api.buttondown.com/v1/external_feeds/{id}"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}
data = {
  "behavior": "draft",
  "cadence": "daily",
  "metadata": {
    "foo": "bar"
  }
}

response = requests.request("PATCH", url, headers=headers, json=data)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3",
    "creation_date": "2020-09-29T00:00:00+00:00",
    "last_checked_date": null,
    "status": "active",
    "behavior": "draft",
    "cadence": "daily",
    "cadence_metadata": {},
    "filters": {
        "filters": [],
        "groups": [],
        "predicate": "and"
    },
    "url": "https://example.com/feed",
    "subject": "New post: {{ item.title }}",
    "body": "I just published a new post: {{ item.url }}",
    "label": "Basic external feed",
    "metadata": {},
    "skip_old_items": true
}

Body parameters

All parameters are optional unless explicitly specified.

behavior

Type
ExternalFeedAutomationBehavior
Example
"draft"

cadence

Type
ExternalFeedAutomationCadence
Example
"daily"

cadence_metadata

Type
object

filters

Type
FilterGroup

subject

Type
string

body

Type
string

label

Type
string

status

Type
ExternalFeedAutomationStatus

metadata

Type
object
Description

Metadata to be passed to emails rendered by this RSS feed.

Example
{ "foo": "bar" }

skip_old_items

Type
boolean
Description

Skip items with publish date older than one day from when they're discovered