Hyros icon

Hyros

Interact with Hyros API - Complete coverage of all endpoints

Actions60

URL Rule → Update

AI-generated

Summary

Replace a URL rule in Hyros using its ID and the rule’s required matching settings. The update is a full replacement, so send the current values of optional settings you want to preserve; omitted optional fields are cleared, and omitting Is Enabled re-enables the rule.

Inputs

  • URL Rule ID (required) — Opaque ID of the rule to update, as returned by Get Many or Create.
  • Name (required) — Descriptive rule label, up to 255 characters.
  • Tag (required) — Tag applied when the rule matches. Use a prefix for the rule flavor: ! for action, @ for source, $ for sale, or # for subscription. With Create Lead Stage enabled, send the stage name without a prefix.
  • Words to Match (required) — Comma-separated words or substrings; the rule matches if any one appears in the inspected URL, ignoring case. Include at least one non-empty value; values cannot contain commas.
  • Source Rule Types (required) — Select at least one URL to inspect: Previous URL or Referrer URL.
  • Additional Fields — Optional rule settings: Apply Base Domain to match only the base domain; Create Lead Stage to create or retain a lead-stage rule; Disregard Source to mark matched traffic low priority; Is Enabled to control whether the rule is active; Scores to assign scores based on keyword groups; Source Category or Source Category Parameter; Traffic Source Category or Traffic Source Parameter; and Words Not to Match to exclude URLs containing any listed word or substring. For each category/parameter pair, choose only one. Score keywords must all occur in the matched URL for that score to apply; when multiple entries match, the highest score wins.

Output shape

A single updated URL rule result inside the Hyros response envelope.

The operation sends a full replacement. Omitted optional fields are cleared by the API; send current values to preserve them. Is Enabled defaults to true, so provide its current value to keep a rule disabled.

Links

Discussion