Update Tag
Update an existing tag by its ID.
Endpoint
PATCH https://api.campaignlark.com/v1/tags/:id
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | required | The tag ID. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | required | The tag name. 1–64 characters. Must be unique within the workspace. |
description | string | optional | A short description of the tag. Max 96 characters. |
Sample Request
PATCH https://api.campaignlark.com/v1/tags/1
Content-Type: application/json
{
"name": "VIP Updated",
"description": "Updated description"
}
Response
Success — 200 OK
{
"data": {
"id": 1,
"name": "VIP Updated",
"description": "Updated description"
}
}
Errors
| Status | Message | Cause |
|---|---|---|
404 | We were unable to find the tag. | Tag does not exist in this workspace. |
400 | Validation error | name is missing, empty, or exceeds 64 characters. |
400 | Validation error | description exceeds 96 characters. |
400 | Validation error | A tag with the new name already exists in the workspace. |
400 | Validation error | An import or export is currently in progress. |