Scheduled emails
Scheduled emails are analogous to, well, scheduled emails; emails that you create to be sent at some point in the future. Depending on your integration, it might make more sense for you to create scheduled emails ahead of time rather than wait to create an email at exactly the time you want it going out (and, just like emails scheduled via Buttondown's UI, scheduled emails created via the API will automatically be sent out without requiring any further intervention.)
The scheduled email object
A scheduled email looks like this:
{"creation_date": "2019-08-24T14:15:22Z","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","body": "Lorem ipsum yadda yadda","subject": "This is my first email on Buttondown!","excluded_tags": [],"included_tags": [],"publish_date": "2019-09-24T14:15:22Z","email_type": "public"}
field | type | description |
---|---|---|
id | uuid | |
creation_date | datetime | |
publish_date | datetime | |
subject | string | |
body | string | |
included_tags | array<string> | array<uuid> | |
excluded_tags | array<string> | array<uuid> | |
email_type | EmailType |
Listing scheduled emails
GET → https://api.buttondown.email/v1/scheduled-emails
Parameters
parameter | type | description | optional |
---|---|---|---|
page | string | A page number within the paginated result set. Each page has 100 results. |
Responses
Status | Description | Sample Response |
---|---|---|
200 |
|
Scheduling a new email to be sent
POST → https://api.buttondown.email/v1/scheduled-emails
Parameters
parameter | type | description | optional |
---|---|---|---|
body | string | ||
subject | string | ||
publish_date | datetime | ||
email_type | string | ||
excluded_tags | array<string> | array<uuid> | ||
included_tags | array<string> | array<uuid> |
Responses
Status | Description | Sample Response |
---|---|---|
201 |
|
Retrieving a specific scheduled email
GET → https://api.buttondown.email/v1/scheduled-emails/<id>
Responses
Status | Description | Sample Response |
---|---|---|
200 |
|
Deleting a specific scheduled email
DELETE → https://api.buttondown.email/v1/scheduled-emails/<id>
Responses
Status | Description | Sample Response |
---|---|---|
204 |
|
Updating or rescheduling a specific scheduled email
PATCH → https://api.buttondown.email/v1/scheduled-emails/<id>
Responses
Status | Description | Sample Response |
---|---|---|
200 |
|