tag/newrule

Creates a new tagging rule for a tag.

Method and path

POST /tag/newrule

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_field	string	yes	Field matched by the rule.
tag_rule	string	yes	Match operator or rule type.
tag_value	string	yes	Match value.

Example request

curl -X POST "$SIGNAL_API_BASE_URL/tag/newrule" \
  -H "X-Api-Key: $SIGNAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": 123,
    "tag_id": 456,
    "tag_field": "post_text",
    "tag_rule": "contains",
    "tag_value": "example keyword"
  }'

{
  "project_id": 123,
  "tag_id": 456,
  "tag_field": "post_text",
  "tag_rule": "contains",
  "tag_value": "example keyword"
}

Example response

{
  "id": 789,
  "tag_field": "post_text",
  "tag_rule": "contains",
  "tag_value": "example keyword"
}

Response fields

Field	Type	Description
id	integer	Rule identifier.
tag_field	string	Matched field.
tag_rule	string	Match operator or rule type.
tag_value	string	Match value.