Skip to content

Support

support_rule_update

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

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

NameTypeRequiredDescription
idstringRule id
devicestringThe new device targeting
enabledbooleanTurn the rule on or off
triggerobjectThe new trigger, replacing the old one
urlMatchobjectThe new URL match, replacing the old one
frequencyobjectThe new frequency, replacing the old one
attributeConditionsarrayThe complete new condition set, replacing the old one. Pass [] to clear it

Response

FieldTypeAlwaysDescription
idstringRule id
devicestringWhich devices the rule applies to. any is the rule that does not care and is the default
enabledbooleanWhether the rule is live
triggerobject
surveyIdstringThe survey this rule delivers
urlMatchobjectWhich pages match
createdAtstringISO-8601 creation timestamp
frequencyobject
updatedAtstringISO-8601 last-modification timestamp
attributeConditionsarrayConditions 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

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

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>"
}

Esc

Start typing to search the docs.

navigateselect