Skip to main content

Update a tag

Rename a tag or change its color. The change applies everywhere the tag is already used.

Endpoint​

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

<tag-uuid> is the UUID of the tag, e.g. TAGd37f22fa-fe01-4a90-b57d-7e83ccc6a05a. You get it from List Tags or Create Tag.

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. Send at least one of them.

FieldTypeRequiredDescription
namestringNoNew name, up to 100 characters. It can't match another tag of your account, ignoring case.
colorstringNoHex color in the #RRGGBB format, e.g. #378ADD.

Invocation​

curl --location --request PUT 'https://api.p.2chat.io/open/tags/TAGd37f22fa-fe01-4a90-b57d-7e83ccc6a05a' \
--header 'Content-Type: application/json' \
--header 'X-User-API-Key: your_api_key_here' \
--data '{
"name": "Hot lead",
"color": "#378ADD"
}'

Response​

Success (HTTP 200 OK)​

{
"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
}
}
FieldDescription
successtrue when the request succeeded
dataThe updated tag. See the tag object.

Error​

{
"success": false,
"error": true,
"error_message": "A tag with that name already exists"
}
HTTP statusWhen
400Neither name nor color was sent, name is longer than 100 characters, or color is not a #RRGGBB hex color
404No tag with that UUID in your account
409Another tag of your account already has that name