Skip to main content

🏷️ Tags

Tags are labels you put on conversations: "Hot lead", "Follow up", "Paid". They are the same tags your team sees in the live chat and in the Tags section of 2Chat, and the ones flows add or remove. Anything you change through the API shows up there right away.

These endpoints let you manage the tags of your account and add or remove them on a conversation. They work the same for WhatsApp Web numbers and WhatsApp Business API (WABA) numbers.

Conversations are identified by their session_key​

A tag goes on a conversation, and the API identifies each conversation by its session_key (e.g. WA-WAN7c43ea2d-f225-45d2-bda9-60f4746f1572-14085550176). You can get it from:

The tag object​

Every endpoint that returns a tag uses this shape:

{
    "uuid": "TAGd37f22fa-fe01-4a90-b57d-7e83ccc6a05a",
    "name": "Hot lead",
    "color": "#378ADD",
    "exclude_from_campaigns": false,
    "created_at": "2026-10-28T17:55:04Z",
    "updated_at": "2026-10-28T18:02:11Z",
    "created_by_user_id": 4809
}
FieldDescription
uuidUnique identifier of the tag. Starts with TAG.
nameName of the tag. Unique per account, ignoring case.
colorHex color shown in 2Chat, like #378ADD. New tags get #CCCCCC.
exclude_from_campaignstrue when the tag is marked in the Tags section of 2Chat so that numbers with it never get a campaign message. Read-only through the API.
created_atWhen the tag was created (UTC, ISO 8601).
updated_atWhen the tag was last changed (UTC, ISO 8601).
created_by_user_idInternal ID of the user who created the tag.