Buttondown logo

External feed cadence metadata

cadence_metadata controls when Buttondown generates emails from a feed. The required fields depend on the feed's cadence:

CadenceRequired fields
everynone
dailytime
weeklytime, weekday
monthlytime, monthday

Allowed values

  • time — an hour of the day in 24-hour format as a string, from "0" through "23" (e.g. "9", "09", or "18"). Times with minutes are not accepted ("10", not "10:00").
  • weekday — one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
  • monthday — a weekday name (interpreted as the first such day of the month), firstday, or lastday.

Requests with values outside these ranges are rejected with a 422 validation error. Missing required fields for the selected cadence return a 400 with code: "cadence_metadata_invalid".

{
    "time": "9"
}

Fields

time

Type
string
Description

Hour of the day (0-23, as a string) when emails should be generated.

weekday

Type
string
Description

Day of the week when emails should be generated. Required when cadence is weekly.

monthday

Type
string
Description

Day of the month when emails should be generated. Accepts a weekday name (first such day of the month), firstday, or lastday. Required when cadence is monthly.