Tags

The tag object

A tag looks like this:

{
"color": "string",
"creation_date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}

fieldtypedescription
creation_datedatetime
iduuid
namestring
descriptionstring
colorstring

Listing tags

GET https://api.buttondown.email/v1/tags

Parameters

parametertypedescriptionoptional
pagestringA page number within the paginated result set.

Responses

StatusDescriptionSample Response
200
{
"count": 1,
"next": "foo",
"previous": null,
"results": [
{
"color": "string",
"creation_date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]
}

Creating a new tag

POST https://api.buttondown.email/v1/tags

Parameters

parametertypedescriptionoptional
namestring
colorstring
descriptionstring

Responses

StatusDescriptionSample Response
201
{
"color": "string",
"creation_date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}

Deleting a tag

DELETE https://api.buttondown.email/v1/tags/<id>

Responses

StatusDescriptionSample Response
204
{}

Retrieving a specific tag

GET https://api.buttondown.email/v1/tags/<id>

Responses

StatusDescriptionSample Response
200
{
"color": "string",
"creation_date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}