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 = {
  "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": "rss_0k28edc3fw896bp4mrhc535z5k",
    "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

cadence

Type
ExternalFeedAutomationCadence

cadence_metadata

Type
CadenceMetadata
Description

Additional scheduling details for the selected cadence. time is required for daily/weekly/monthly cadences; weekday is required for weekly; monthday is required for monthly. See the cadence metadata reference for allowed values.

filters

Type
FilterGroup

subject

Type
string

body

Type
string

label

Type
string
Description

An optional internal label for this feed.

status

Type
string
Description

The current status of the external feed automation.

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