v4

latestOpenAPI 3.1.0MIT2026-08-02128224900.7 KB
Tags

Update Tag

Update a tag's properties

patch/tags/{id}

Path parameters

idstring required

Request body

namestring nullable

The name of the tag.

colorstring nullable

The hex color code associated with the tag.

descriptionstring nullable

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

public_descriptionstring nullable

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

secondary_idinteger nullable

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

subscriber_editableboolean nullable

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

Example request

{
  "name": "VIP",
  "color": "#FFD700"
}

Response

OK

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

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

namestring required

The name of the tag.

colorstring required

The hex color code associated with the tag.

descriptionstring nullable

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

public_descriptionstring nullable

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

subscriber_editableboolean required

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

secondary_idinteger required

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