Exports
Some software applications may want programmatic access to their newsletter exports. This assists with a few niche use cases, such as regular backups or data ingestion (into a data warehouse), or post-publishing processes that hinge on email events. In general, you probably won't need to use this endpoint unless you absolutely need to use this endpoint.
The export object
An export looks like this:
{"creation_date": "2019-08-24T14:15:22Z","completion_date": "2019-08-24T15:15:22Z","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","url": "s3://buttondown/path-to-export","status": "completed"}
field | type | description |
---|---|---|
creation_date | datetime | |
completion_date | datetime | |
status | status | |
id | uuid | |
url | string |
Listing exports
GET → https://api.buttondown.email/v1/exports
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 |
|
Creating a new export
POST → https://api.buttondown.email/v1/exports
Parameters
parameter | type | description | optional |
---|
Responses
Status | Description | Sample Response |
---|---|---|
201 |
|
Deleting an export
DELETE → https://api.buttondown.email/v1/exports/<id>
Responses
Status | Description | Sample Response |
---|---|---|
204 |
|
Retrieving a specific export
GET → https://api.buttondown.email/v1/exports/<id>
Responses
Status | Description | Sample Response |
---|---|---|
200 |
|