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

field	type	description
creation_date	datetime
id	uuid
name	string
description	string
color	string

Listing tags

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

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

Status

Description

Sample 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

parameter	type	description	optional
name	string
color	string
description	string

Responses

Status	Description	Sample 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

Status	Description	Sample Response
204		{}

Retrieving a specific tag

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

Responses

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

On this page

Retrieving a specific tag