Buttondown logo

Introduction

Routes

Listing tagsRetrieving a tagCreating a tagUpdating a tagDeleting a tagTag analytics

Buttondown logo

Creating a tag

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/tags"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}
data = {
  "name": "VIP",
  "color": "#FFD700"
}

response = requests.request("POST", url, headers=headers, json=data)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "name": "VIP",
    "color": "#FFD700",
    "description": "VIP subscribers",
    "public_description": null,
    "subscriber_editable": false,
    "id": "sub_tag_0k28edc3fw896bp4mrhc535z5k",
    "creation_date": "2020-09-29T00:00:00+00:00",
    "secondary_id": 1
}

Body parameters

All parameters are optional unless explicitly specified.

name

Type
string · required
Description

The name of the tag.

Example
"VIP"

color

Type
string · required
Description

The hex color code associated with the tag.

Example
"#FFD700"

description

Type
string
Description

An internal description of the tag, only visible to the newsletter author.

public_description

Type
string
Description

A public-facing description of the tag, visible to subscribers in the subscriber portal.

subscriber_editable

Type
boolean
Description

If true, subscribers can add or remove this tag from their own profile via the subscriber portal.