Hyros icon

Hyros

Interact with Hyros API - Complete coverage of all endpoints

Actions60

URL Rule → Create

AI-generated

Summary

Create a Hyros URL rule that applies a tag when a selected previous or referrer URL contains any configured matching word or substring. Optional settings control URL scope, exclusions, source categories, traffic priority, lead-stage creation, and sale scores.

Inputs

  • Name (required) — Descriptive rule label, up to 255 characters.
  • Tag (required) — Tag applied when the rule matches. Use the prefix ! for an action tag, @ for a source tag, $ for a sale tag, or # for a subscription tag. Enable Create Lead Stage to send a prefix-free lead stage name.
  • Words to Match (required) — Comma-separated words or substrings; the rule matches if the inspected URL contains any one of them, ignoring case. Include at least one non-empty value; individual values cannot contain commas.
  • Source Rule Types (required) — Select at least one URL to inspect: Previous URL, Referrer URL, or both.
  • Apply Base Domain — Match against the base domain instead of the complete URL. Defaults to false.
  • Create Lead Stage — Create a lead-stage rule. The Tag becomes the stage name and must have no prefix. Defaults to false.
  • Disregard Source — Mark matched traffic as low priority so it does not override an existing source. Defaults to false.
  • Is Enabled — Whether the rule is active. Defaults to true.
  • Scores — Add keyword groups and a score. All keywords in an entry must appear in the matched URL, ignoring case; if multiple entries match, the highest score wins. A score of 0 marks the sale as unqualified.
  • Source Category — Assign a fixed source category by name; Hyros creates the category if needed. Mutually exclusive with Source Category Parameter.
  • Source Category Parameter — Read the source category from a URL parameter. Accepts one value of up to 255 characters without commas; mutually exclusive with Source Category.
  • Traffic Source Category — Assign a fixed traffic source category by name; Hyros creates the category if needed. Mutually exclusive with Traffic Source Parameter.
  • Traffic Source Parameter — Read the traffic source from a URL parameter, such as utm_source. Accepts one value of up to 255 characters without commas; mutually exclusive with Traffic Source Category.
  • Words Not to Match — Comma-separated words or substrings that exclude a URL from matching if any are present, ignoring case. Individual values cannot contain commas.

Output shape

A single result object containing the created URL rule.

The synchronous create response includes the new rule's ur- identifier.

Links

Discussion