Add Jump Logic Rule
add_jump_logic_ruleAdds a jump (branching/skip) rule to a survey: when the SOURCE question's answer matches the condition, the respondent skips forward to a target page, or the survey finishes. The rule fires when the source question's page is submitted, so jumps only go FORWARD: the target page must be strictly after the source's page — put the branching/screening question on an EARLIER, SEPARATE page than the questions it gates (create pages with add_survey_page). A backward or same-page target is an explicit error. target is a 1-based page number or 'end'. target='end' finishes the survey right there as a LEGITIMATE COMPLETED response — the branch simply ends early; it is not a screen-out or disqualification. Operator and value work like add_display_logic_rule conditions (option code for choice questions, literal for text/number). Verified by readback: the reply is the rule as actually stored in the survey. Requires the edit-survey right.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | Survey publication code — the 8-character code from the survey's public link (e.g. 1a2b3c4d). Returned by list_surveys. | |
| value | No | Value to compare against: the option's numeric code for choice questions (get_survey lists them), a number or text otherwise. Omit for is_empty/is_not_empty. | |
| target | No | Where to go when the condition matches: a 1-based page number strictly after the source question's page, or 'end' to finish the survey as completed. | |
| operator | Yes | Comparison operator, e.g. equals / not_equals / greater / less_or_equal / is_empty. | |
| question | Yes | Variable code of the SOURCE question whose answer is checked (Q1, Q2, … from get_survey). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message | No | What the call did, verified, refused or previewed — the complete human-readable outcome. | |
| preview | No | true when the call was a preview (confirm not passed): nothing was changed. |