Tags
Update Tag Group
Rename a group, or switch it between single and multi
PUT
/
tag-groups
/
{groupId}
curl -X PUT "https://api.clustr-ai.com/api/public/tag-groups/5a1c3f88-92d4-4b0e-8e7a-1f2b3c4d5e60" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Pipeline stage"}'
{
"success": true,
"data": {
"group": {
"id": "5a1c3f88-92d4-4b0e-8e7a-1f2b3c4d5e60",
"subject_type": "account",
"name": "Pipeline stage",
"selection": "single",
"position": 2,
"is_system": false
}
}
}
{
"success": false,
"error": { "message": "some records carry two tags from this group", "code": "CONFLICT" }
}
{
"success": false,
"error": { "message": "tag group not found", "code": "NOT_FOUND" }
}
Only provided fields change.
subject_type is not editable.
Switching
multi to single fails with 409 while some record carries two
of the group’s tags. That is the correct answer: the alternative is silently
dropping one. Take the extra tags off those records first, then switch.Path Parameters
string
required
The group’s id, from List Tag Groups.
Body
string
1-80 characters. Renaming breaks nothing: assignments, filters and saved views
all reference ids.
string
single or multi.curl -X PUT "https://api.clustr-ai.com/api/public/tag-groups/5a1c3f88-92d4-4b0e-8e7a-1f2b3c4d5e60" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Pipeline stage"}'
{
"success": true,
"data": {
"group": {
"id": "5a1c3f88-92d4-4b0e-8e7a-1f2b3c4d5e60",
"subject_type": "account",
"name": "Pipeline stage",
"selection": "single",
"position": 2,
"is_system": false
}
}
}
{
"success": false,
"error": { "message": "some records carry two tags from this group", "code": "CONFLICT" }
}
{
"success": false,
"error": { "message": "tag group not found", "code": "NOT_FOUND" }
}
⌘I
curl -X PUT "https://api.clustr-ai.com/api/public/tag-groups/5a1c3f88-92d4-4b0e-8e7a-1f2b3c4d5e60" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Pipeline stage"}'
{
"success": true,
"data": {
"group": {
"id": "5a1c3f88-92d4-4b0e-8e7a-1f2b3c4d5e60",
"subject_type": "account",
"name": "Pipeline stage",
"selection": "single",
"position": 2,
"is_system": false
}
}
}
{
"success": false,
"error": { "message": "some records carry two tags from this group", "code": "CONFLICT" }
}
{
"success": false,
"error": { "message": "tag group not found", "code": "NOT_FOUND" }
}