Documentation Index
Fetch the complete documentation index at: https://developers.chameleon.io/llms.txt
Use this file to discover all available pages before exploring further.
Tags are:
Schema
| Property | Type | Description |
|---|
id | ID | The Chameleon ID |
created_at | timestamp | When this happened or when this was added to the Database |
updated_at | timestamp | The last time any property was updated |
uid | string | The normalized name. Or an external ID |
name | string | The original text entered for the Tag |
description | string | The display description |
models_count | number | The number of Experiences attached to this Tag |
disabled_at | timestamp | A timestamp indicating that this tag should no longer be displayed in the UI |
last_seen_at | timestamp | This last time this Tag was added or removed from an Experience |
HTTP Request
https://api.chameleon.io/v3/edit/tags
| param | - | description |
|---|
limit | optional | Defaults to 50 with a maximum of 500 |
before | optional | Used when paginating, use directly from the cursor object from the previous response |
before | optional | Read as “created before” and can be given as a timestamp to get only limit items that were created before this time |
after | optional | Read as “created after” and can be given as a timestamp or ID to get only limit items that were created after this time |
HTTP Response
{
"tags": [
{
"id": "5f3c4232c712de665632a5f1",
"uid": "new_features",
"name": "New Features 🎉",
"description": "Any feature announcement",
"models_count": 3,
"disabled_at": null,
"last_seen_at": "2029-04-07T12:18:00Z"
},
{
"id": "5f3c4232c712de665632a5f2",
"uid": "01_onboarding",
"name": "01 Onboarding 🚧",
"description": "Any onboarding prompt",
"models_count": 12,
"disabled_at": null,
"last_seen_at": "2029-04-09T12:19:00Z"
},
...
],
"cursor": {
"limit": 50,
"before": "5c4950c34733cc0004d5bfd2"
}
}
Filtering by Segment
See Listing Related models
Retrieve a Tag
HTTP Request
https://api.chameleon.io/v3/edit/tags/:id
| param | - | description |
|---|
id | required | The Chameleon ID of the Tag to show |
HTTP Response
{
"tag": {
"id": "5f3c4232c712de665632a5f2",
"uid": "01_onboarding",
"name": "01 Onboarding 🚧",
"description": "Any onboarding prompt",
"models_count": 12,
"disabled_at": null,
"last_seen_at": "2029-04-09T12:19:00Z",
...
}
}
Bulk tag operations
Apply multiple tag operations across multiple Experiences (Tours, Microsurveys, Tooltips, Launchers) in a single request. This endpoint is optimized for bulk updates.
Check out this guide with specific examples
A Tour, Microsurvey, and Embed is model_type=Campaign when used in this API
- Tags names are automatically normalized when created
- If a tag name is provided that doesn’t exist, it will be created automatically
- Multiple operations on the same model are applied in order
- When using
tag_names array, the model’s tags are set to exactly the specified list (tags not in the list are removed)
- Tag counts (
models_count) are updated automatically
- The
last_seen_at timestamp is updated for all affected tags
HTTP Request
https://api.chameleon.io/v3/edit/tags/bulk
| param | - | description |
|---|
updates | required | An array of tag update operations to perform |
| Property | Type | Description |
|---|
model_id | ID | The Chameleon ID of the model to update |
model_type | string | The type of model: Campaign, Tooltip, List (Microsurveys and Embeddables are considered a Campaign here) |
tag_id | string | The tag ID prefixed with + to add or - to remove (e.g., "+5f3c4232c712de665632a5f1" or "-5f3c4232c712de665632a5f1") |
| Property | Type | Description | |
|---|
model_id | ID | The Chameleon ID of the model to update | |
model_type | string | The type of model: Campaign, Tooltip, List (Microsurveys and Embeddables are considered a Campaign here) | |
tag_name | string | The tag name prefixed with + to add or - to remove (e.g., "+Feature" or "-Bug") | |
| Property | Type | Description | |
|---|
model_id | ID | The Chameleon ID of the model to update | |
model_type | string | The type of model: Campaign, Tooltip, List (Microsurveys and Embeddables are considered a Campaign here) | |
tag_names | array<string> | Array of tag names to set (creates tags if needed). The model’s tags will be set to exactly this list | |
HTTP Response
Returns an array of updated models with their final tag state:
{
"updates": [
{
"model_id": "5f3c4232c712de665632a3b1",
"model_type": "Campaign",
"tag_ids": ["5f3c4232c712de665632a5f1", "5f3c4232c712de665632a5f2"]
},
{
"model_id": "5f3c4232c712de665632a3b2",
"model_type": "Tooltip",
"tag_ids": ["5f3c4232c712de665632a5f1"]
}
]
}
Examples
Add multiple tags to different models:
{
"updates": [
{
"model_id": "5f3c4232c712de665632a3b1",
"model_type": "Campaign",
"tag_id": "+5f3c4232c712de665632a5f1"
},
{
"model_id": "5f3c4232c712de665632a3b1",
"model_type": "Campaign",
"tag_id": "+5f3c4232c712de665632a5f2"
},
{
"model_id": "5f3c4232c712de665632a3b2",
"model_type": "Tooltip",
"tag_name": "+NewFeature"
}
]
}
{
"updates": [
{
"model_id": "5f3c4232c712de665632a3b1",
"model_type": "Campaign",
"tag_id": "-5f3c4232c712de665632a5f1"
}
]
}
{
"updates": [
{
"model_id": "5f3c4232c712de665632a3b1",
"model_type": "Campaign",
"tag_names": ["Feature", "Onboarding", "Priority"]
}
]
}
{
"updates": [
{
"model_id": "5f3c4232c712de665632a3b1",
"model_type": "Campaign",
"tag_names": ["Feature", "Enhancement"]
},
{
"model_id": "5f3c4232c712de665632a3b2",
"model_type": "Tooltip",
"tag_id": "+5f3c4232c712de665632a5f1"
},
{
"model_id": "5f3c4232c712de665632a3b3",
"model_type": "Campaign",
"tag_name": "+Bug"
}
]
}
