support_rule_update

Tool

support_rule_update

Edit a delivery rule: its URL match, device, trigger, frequency, conditions, or whether it is live at all.

Edit a delivery rule: its URL match, device, trigger, frequency, conditions, or whether it is live at all. Every value replaces the old one whole rather than merging into it. The survey is not editable — a rule is the targeting OF one survey, and retargeting it silently would change what every matching page shows; delete it and write the one you meant. Switching a rule off is the quiet way to stop delivering without touching the survey

Behavior

HTTP: PATCH /support/rules/:id

Arguments

Name	Type	Required	Description
id	string	•	Rule id
device	string	—	The new device targeting
enabled	boolean	—	Turn the rule on or off
trigger	object	—	The new trigger, replacing the old one
urlMatch	object	—	The new URL match, replacing the old one
frequency	object	—	The new frequency, replacing the old one
attributeConditions	array	—	The complete new condition set, replacing the old one. Pass [] to clear it

Response

Field	Type	Always	Description
id	string	•	Rule id
device	string	•	Which devices the rule applies to. any is the rule that does not care and is the default
enabled	boolean	•	Whether the rule is live
trigger	object	•	When the client’s runtime shows the survey once the page matches: immediately, after a delay, or on an event of its own
surveyId	string	•	The survey this rule delivers
urlMatch	object	•	Which pages match
createdAt	string	•	ISO-8601 creation timestamp
frequency	object	•	How often the same person may see this survey. The client’s runtime enforces it — this toolkit never sees the end user
updatedAt	string	•	ISO-8601 last-modification timestamp
attributeConditions	array	•	Conditions on the visitor’s attributes, ALL of which must hold

Try it

Edit a delivery rule: its URL match, device, trigger, frequency, conditions, or whether it is live at all.

When to use

Example

Ask your agent something like this:

Edit a delivery rule: its URL match, device, trigger, frequency, conditions, or whether it is live at all.

The agent will invoke support_rule_update with these arguments:

{
  "id": "<id>"
}