tag/edit

Updates an existing tag.

Method and path

POST /tag/edit

Authentication

Authentication is required. See Authentication.

Permissions

Accessible to tier 1, 2, and 3 users.

Request headers

Header	Required	Description
X-Api-Key or X_API_KEY	yes	API key.
Content-Type	yes	application/json.

Request body

Field	Type	Required	Description
project_id	integer	yes	Project identifier.
tag_id	integer	yes	Tag identifier.
tag_label	string	yes	Updated tag label.
tag_folder_id	integer	yes	Updated folder identifier.
public_tag	boolean	no	Public flag. If omitted, the stored value is false.
alert_whitelist	boolean	no	Alert whitelist flag. If omitted, the stored value is false.

Example request

curl -X POST "$SIGNAL_API_BASE_URL/tag/edit" \
  -H "X-Api-Key: $SIGNAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": 123,
    "tag_id": 456,
    "tag_label": "Updated Tag",
    "tag_folder_id": 8
  }'

{
  "project_id": 123,
  "tag_id": 456,
  "tag_label": "Updated Tag",
  "tag_folder_id": 8,
  "public_tag": true,
  "alert_whitelist": false
}

Example response

{
  "id": 456,
  "label": "Updated Tag",
  "alert_whitelist": 0,
  "public_tag": 1,
  "folder": {
    "id": 8,
    "label": "Updated Folder"
  }
}

Response fields

Field	Type	Description
id	integer	Tag identifier.
label	string	Tag label.
alert_whitelist	integer	Flag returned as 0 or 1.
public_tag	integer	Flag returned as 0 or 1.
folder	object	Folder assigned to the tag after the update.

Notes

• The response returns the updated tag object.