Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.usetitan.app/llms.txt

Use this file to discover all available pages before exploring further.

Labels are a WhatsApp Business feature that lets you tag and organize chats. You can create labels with custom names and colors, then assign them to one or more chats to group related conversations. Labels are visible in the WhatsApp Business app and help your team manage large volumes of conversations.
Labels are only available for sessions linked to WhatsApp Business accounts. Standard consumer accounts do not support labels.

​
Label object

​
id
string
Unique label identifier assigned by WhatsApp.
​
name
string
Label display name.
​
color
integer
Label color as a palette index (integer). WhatsApp maps these indices to specific colors in the UI.

​
List labels

curl https://api.example.com/api/sessions/default/labels \
  -H "Authorization: Bearer titan_..."
GET /api/sessions/{session}/labels Returns all labels for the session account.
​
session
string
required
Session name.
{
  "data": [
    { "id": "1", "name": "VIP", "color": 1 },
    { "id": "2", "name": "Follow-up", "color": 5 }
  ]
}

​
Create a label

curl -X POST https://api.example.com/api/sessions/default/labels \
  -H "Authorization: Bearer titan_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "VIP", "color": 1}'
POST /api/sessions/{session}/labels Creates a new label for the session account.
​
session
string
required
Session name.
​
name
string
required
Label display name.
​
color
integer
Color palette index. WhatsApp supports a fixed set of color indices for labels.
{
  "data": {
    "id": "3",
    "name": "VIP",
    "color": 1
  }
}

​
Update a label

curl -X PUT https://api.example.com/api/sessions/default/labels/3 \
  -H "Authorization: Bearer titan_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "Priority Customer", "color": 2}'
PUT /api/sessions/{session}/labels/{labelId} Updates the name or color of an existing label.
​
session
string
required
Session name.
​
labelId
string
required
Label ID.
​
name
string
New label display name.
​
color
integer
New color palette index.
{
  "data": {
    "id": "3",
    "name": "Priority Customer",
    "color": 2
  }
}

​
Delete a label

curl -X DELETE https://api.example.com/api/sessions/default/labels/3 \
  -H "Authorization: Bearer titan_..."
DELETE /api/sessions/{session}/labels/{labelId} Deletes a label. Existing chat assignments are removed automatically.
​
session
string
required
Session name.
​
labelId
string
required
Label ID.
{
  "data": { "success": true, "message": "label deleted" }
}

​
Assign a label to chats

curl -X POST https://api.example.com/api/sessions/default/labels/3/chats \
  -H "Authorization: Bearer titan_..." \
  -H "Content-Type: application/json" \
  -d '{
    "labels": ["[email protected]", "[email protected]"]
  }'
POST /api/sessions/{session}/labels/{labelId}/chats Assigns a label to one or more chats.
​
session
string
required
Session name.
​
labelId
string
required
Label ID to assign.
​
labels
string[]
required
Array of chat JIDs to assign the label to.
{
  "data": { "success": true, "message": "label assigned" }
}

​
Remove a label from chats

curl -X DELETE https://api.example.com/api/sessions/default/labels/3/chats \
  -H "Authorization: Bearer titan_..." \
  -H "Content-Type: application/json" \
  -d '{
    "labels": ["[email protected]"]
  }'
DELETE /api/sessions/{session}/labels/{labelId}/chats Removes a label from one or more chats.
​
session
string
required
Session name.
​
labelId
string
required
Label ID to remove.
​
labels
string[]
required
Array of chat JIDs to remove the label from.
{
  "data": { "success": true, "message": "label removed" }
}