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"
}

fieldtypedescription
creation_datedatetime
iduuid
descriptionstring
namestring
usernamestring
api_keystring

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

parametertypedescriptionoptional
pagestringA page number within the paginated result set.

Responses

StatusDescriptionSample Response
200
{
"count": 1,
"next": "foo",
"previous": null,
"results": [
{
"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"
}
]
}

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

parametertypedescriptionoptional
namestring
usernamestring
descriptionstring

Responses

StatusDescriptionSample Response
201
{
"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"
}

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

StatusDescriptionSample Response
200
{
"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"
}

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

StatusDescriptionSample 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

StatusDescriptionSample Response
200
{
"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"
}