Add a tag to a conversation

Read with ChatGPTRead with Claude

Put an existing tag on a conversation. Your team sees it in the live chat right away. If the conversation already has the tag, nothing changes.

To create the tag and put it on the conversation in a single call, send a session_key to Create Tag.

Endpoint

POST https://api.p.2chat.io/open/tags/<tag-uuid>/sessions

<tag-uuid> is the UUID of the tag, e.g. TAGd37f22fa-fe01-4a90-b57d-7e83ccc6a05a.

Authentication

Include your API key in the X-User-API-Key header. Learn more about authentication.

Parameters

These parameters should be sent as JSON payload in the request body.

Field	Type	Required	Description
session_key	string	Yes	The conversation to put the tag on. See where to get it.

Invocation

cURL

curl --location --request POST 'https://api.p.2chat.io/open/tags/TAGd37f22fa-fe01-4a90-b57d-7e83ccc6a05a/sessions' \
--header 'Content-Type: application/json' \
--header 'X-User-API-Key: your_api_key_here' \
--data '{
    "session_key": "WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176"
}'

Python

import requests

url = "https://api.p.2chat.io/open/tags/TAGd37f22fa-fe01-4a90-b57d-7e83ccc6a05a/sessions"
headers = {
    "Content-Type": "application/json",
    "X-User-API-Key": "your_api_key_here"
}
payload = {
    "session_key": "WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

JavaScript

const axios = require('axios');

const response = await axios.post('https://api.p.2chat.io/open/tags/TAGd37f22fa-fe01-4a90-b57d-7e83ccc6a05a/sessions', {
    session_key: 'WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176'
}, {
    headers: {
        'Content-Type': 'application/json',
        'X-User-API-Key': 'your_api_key_here'
    }
});

console.log(response.data);

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.p.2chat.io/open/tags/TAGd37f22fa-fe01-4a90-b57d-7e83ccc6a05a/sessions',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => json_encode([
      'session_key' => 'WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176'
  ]),
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'X-User-API-Key: your_api_key_here'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response

Success

HTTP 201 Created when the tag was added, 200 OK when the conversation already had it. The body is the same in both cases.

{
    "success": true,
    "data": {
        "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
    }
}

Field	Description
success	true when the request succeeded
data	The tag. See the tag object.

Error

{
    "success": false,
    "error": true,
    "error_message": "Payload is invalid. Make sure all required fields are present and with valid values: session_key does not belong to this account"
}

HTTP status	When
400	session_key is not a conversation of your account
404	No tag with that UUID in your account
422	session_key is missing