Newsletters
The newsletter object
A newsletter looks like this:
{"api_key": "7f819f8f-8220-4dcd-b7e3-37c81ead8b7a","creation_date": "2019-08-24T14:15:22Z","description": "string","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","username": "string"}
field | type | description |
---|---|---|
creation_date | datetime | |
id | uuid | |
description | string | |
name | string | |
username | string | |
api_key | string |
Listing newsletters
info
This endpoint is currently in closed beta! If you are interested in using it, email me and I will get you situated.
GET → https://api.buttondown.email/v1/newsletters
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 newsletter
info
This endpoint is currently in closed beta! If you are interested in using it, email me and I will get you situated.
POST → https://api.buttondown.email/v1/newsletters
Parameters
parameter | type | description | optional |
---|---|---|---|
name | string | ||
username | string | ||
description | string |
Responses
Status | Description | Sample Response |
---|---|---|
201 |
|
Retrieving a specific newsletter
info
This endpoint is currently in closed beta! If you are interested in using it, email me and I will get you situated.
GET → https://api.buttondown.email/v1/newsletters/<id>
Responses
Status | Description | Sample Response |
---|---|---|
200 |
|
Deleting a specific newsletter
info
This endpoint is currently in closed beta! If you are interested in using it, email me and I will get you situated.
DELETE → https://api.buttondown.email/v1/newsletters/<id>
Responses
Status | Description | Sample Response |
---|---|---|
204 |
|
Updating a specific newsletter
info
This endpoint is currently in closed beta! If you are interested in using it, email me and I will get you situated.
PATCH → https://api.buttondown.email/v1/newsletters/<id>
Responses
Status | Description | Sample Response |
---|---|---|
200 |
|