Buttondown logo

Introduction

Tags are a way to organize your subscribers. You can create, update, and delete tags via the API. You can also list all tags for a given newsletter.

Tags don't have any strict functionality on their own, but you can send emails to subscribers with a given tag (or to all subscribers without a given tag.)

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

Fields

id

Type
string
Description

A unique TypeID associated with the object.

creation_date

Type
string
Description

The date and time at which the object was first created.

name

Type
string
Description

The name of the tag.

color

Type
string
Description

The hex color code associated with the tag.

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.

secondary_id

Type
integer
Description

The secondary ID of the tag, used as a human-readable numeric identifier.