Buttondown Documentation
These sample requests are autogenerated by the OpenAPI spec.
The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.
All parameters are optional unless explicitly specified.
"The subject line for the email"
Can be either HTML or markdown.
"This is an example of the body of an email."
A structured key-value blob that you can use to store arbitrary data on the object. (You can read more about metadata.)
Designated whether or not this email should be highlighted within the archives. (Currently unused.)
Whether this email should trigger pay-per-email billing for paid subscribers. Use this to differentiate between free updates and premium newsletters.
This endpoint may return the following error codes. See the error codes reference for more details about error handling.
Error Code | Description |
---|---|
body_invalid | The email body provided is invalid or cannot be parsed. |
canonical_url_invalid | The canonical URL provided is not a valid URL. |
email_duplicate | An email with the same identifiers already exists. |
email_invalid | The email is invalid. |
publish_date_invalid | The publish date provided is not valid or is in an incorrect format. |
publish_date_missing | A publish date is required but was not provided. |
slug_invalid | The slug provided is invalid or already in use. |
status_invalid | The status provided is not valid. |
subject_invalid | The subject provided is invalid or missing. |
tag_invalid | The tag provided is invalid or does not exist. |