A tag is a label on campaigns, journeys, segments and templates, such as "Black Friday", for filtering lists and reports. A tag is not an audience: to group contacts, use a list or a segment. A tag that a segment or journey rule names cannot be deleted until the rule stops naming it.
Endpoints
| Endpoint | Request |
|---|---|
| List tags | GET /v1/tags |
| Create a tag | POST /v1/tags |
| Rename a tag | PATCH /v1/tags/{id} |
| Delete a tag | DELETE /v1/tags/{id} |
| Merge a tag into another | POST /v1/tags/{id}/merge |
The Tag object
{
"id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
"name": "name_example",
"usage": {
"campaigns": 0,
"journeys": 0,
"segments": 0,
"templates": 0
},
"createdAt": "2030-03-14T09:30:00Z",
"updatedAt": "2030-03-14T09:30:00Z"
}idstringrequireduuid
namestringrequiredusageobjectrequiredHow many items of each kind carry the tag.
4 child attributes
campaignsintegerrequiredmin 0
journeysintegerrequiredmin 0
segmentsintegerrequiredmin 0
templatesintegerrequiredmin 0
createdAtstringrequireddate-time
updatedAtstringrequireddate-time