v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

Tag Management

Modify tag

This API allows you to modify an existing custom tag. You can update the tag's name, description, color, and customization logic.

put/v2/analytics/tags/{tag_uuid}

Path parameters

tag_uuidstring uuid required

The unique identifier of the tag that you want to modify.

Request body

namestring required

The updated name of the tag.

descriptionstring required

The updated description of the tag.

colorstring required

The updated hex code to visually represent the tag in the Dashboard.

Example request

{
  "name": "Deposit",
  "description": "baker street 123",
  "color": "#777",
  "customization": {
    "amount": {
      "lt": 10,
      "gt": 100,
      "eq": 50
    },
    "include_terms": [
      "create inc 1",
      "create inc 2"
    ],
    "exclude_terms": [
      "create exc 1",
      "create exc 2"
    ],
    "recurrence": {
      "min_days": 30,
      "max_days": 60
    }
  }
}

Response

Tag Modified Successfully

{"stackTrail":"paths:/v2/analytics/tags/{tag_uuid}:put:responses:204:content:application/json:schema","oasType":"schema","type":"unknown","title":"Tag Modified Successfully"}