Skip to content

tag/new

Creates a tag inside a project.

What is a tag?

A tag is a project-level label used to classify posts, organize them into folders, and support automated tagging rules.

Method and path

POST /tag/new

Authentication

Authentication is required. See Authentication.

Permissions

Accessible to tier 1, 2, and 3 users.

Request headers

HeaderRequiredDescription
X-Api-Key or X_API_KEYyesAPI key.
Content-Typeyesapplication/json.

Request body

FieldTypeRequiredDescription
project_idintegeryesProject identifier.
tag_labelstringyesTag label.
tag_folder_idintegeryesTarget folder identifier.
public_tagbooleannoPublic flag. If omitted, the stored value is false.
alert_whitelistbooleannoAlert whitelist flag. If omitted, the stored value is false.

Example request

bash
curl -X POST "$SIGNAL_API_BASE_URL/tag/new" \
  -H "X-Api-Key: $SIGNAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": 123,
    "tag_label": "Example Tag",
    "tag_folder_id": 7
  }'
json
{
  "project_id": 123,
  "tag_label": "Example Tag",
  "tag_folder_id": 7,
  "public_tag": false,
  "alert_whitelist": false
}

Example response

json
{
  "id": 456,
  "label": "Example Tag",
  "alert_whitelist": 0,
  "public_tag": 0,
  "folder": {
    "id": 7,
    "label": "Example Folder"
  }
}

Response fields

FieldTypeDescription
idintegerTag identifier.
labelstringTag label.
alert_whitelistintegerFlag returned as 0 or 1.
public_tagintegerFlag returned as 0 or 1.
folderobjectFolder assigned to the tag.

Notes

  • The response returns the created tag with its resolved folder object.

Doc rev.1.12.3 2026.05.08