Quiz settings
update_quiz_settingsDestructive
Updates quiz settings (title, language, display, navigation, time and response limits, captcha, theme, QR code, time to complete the quiz, IP / device rules, scheduled access, analytics and pixels, SSO, anonymous responses, category scoring, etc.). Only pass fields you want to change; all others are left unchanged.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"quiz_id": "<quiz_id>"
},
"name": "update_quiz_settings"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | Survey UI language: ru, en, es, or pt. | |
| name | No | Quiz title (max 255 characters). | |
| quiz_id | Yes | Quiz ID whose settings should be updated. | |
| theme_id | No | Theme ID: a public theme or a theme of the quiz workspace (integer ≥ 1). | |
| info_title | No | Title (meta, max 500 characters). | |
| numeration | No | Enable question numbering. | |
| sso_active | No | Require SSO sign-in before taking the quiz. | |
| description | No | Quiz description (meta, max 5000 characters). | |
| multiple_ip | No | Allow completing the quiz from multiple IPs (otherwise one IP per completion). | |
| show_by_one | No | Show one question per screen. | |
| extra_fields | No | List of hidden variables (extra fields): array of objects with id (UUID) and name (max 250 characters). | |
| ip_blacklist | No | Blocked IPs list (max 5000 characters). | |
| ip_whitelist | No | Allowed IPs list (max 5000 characters). | |
| qr_code_size | No | QR code size in pixels (1–1000). | |
| show_captcha | No | Show captcha when submitting a response. | |
| use_password | No | Require a password to open the quiz. | |
| fb_pixel_code | No | Facebook pixel id (max 100 chars). | |
| qr_code_color | No | QR code color (max 50 characters). | |
| schedule_days | No | Weekdays the quiz is available on: array of ISO numbers 1-7 (1 = Monday, 7 = Sunday). | |
| show_navigate | No | Show navigation (back / forward buttons). | |
| qr_code_format | No | QR code file format: png, svg or eps. This is the quiz setting that is remembered; the code itself is built by manage_quiz_qr_code. | |
| qr_code_margin | No | QR code margin (0–100). | |
| show_to_robots | No | Whether the quiz page is available to search engine crawlers. | |
| correct_answers | No | Show and use correct answers in the test scenario. | |
| ip_list_enabled | No | Enable filtering by IP lists (allow / block lists). | |
| is_change_theme | No | Change appearance theme based on data embedded in the QR code. | |
| quiz_categories | No | Categories for category scoring: array of objects { "id": "<string>", "name": "<title>" }. Order matters: on a score tie the earlier category wins. Category weights are set on widget options, not here. | |
| scripts_in_body | No | Script code injected into <body> (max 65535 characters). Stored without sanitization — content security is the responsibility of whoever renders the quiz. | |
| scripts_in_head | No | Script code injected into <head> (max 65535 characters). Stored without sanitization — content security is the responsibility of whoever renders the quiz. | |
| category_scoring | No | Enable category scoring: option scores are summed per category and the winning category is stored with the answer. | |
| limit_time_value | No | End date/time for availability (max 50 characters; empty string resets). | |
| matrix_transpose | No | Transpose matrix questions in the report: rows and columns swap places. | |
| schedule_enabled | No | Enable scheduled access to the quiz (weekdays + time window). | |
| schedule_time_to | No | End of the availability window in H:i format (e.g. "18:00"). Interpreted in schedule_timezone. | |
| scoring_switcher | No | Enable the score summary toggle in the quiz. | |
| show_progressbar | No | Show a progress bar while taking the quiz. | |
| sso_allow_retake | No | Let an SSO respondent take the quiz again. | |
| available_devices | No | Allowed devices: array of desktop, mobile, tablet. | |
| schedule_timezone | No | Schedule timezone, IANA identifier (e.g. "America/New_York"). | |
| answers_allow_edit | No | Let the respondent edit an already submitted answer. Works only together with SSO (sso_active) or e-mail verification (require_email_verification) — otherwise no edit link is issued. | |
| auto_move_by_enter | No | Go to the next question when Enter is pressed. | |
| auto_save_progress | No | Auto-save progress: the respondent can come back and continue where they left off. | |
| captcha_public_key | No | Captcha public key (max 500 characters). | |
| captcha_secret_key | No | Captcha secret key (max 500 characters). | |
| close_quiz_enabled | No | Quiz is closed (responses are disabled). | |
| fb_pixel_is_active | No | Enable the Facebook pixel. | |
| limit_message_body | No | Body text of the message when the response limit is reached (max 5000 characters). | |
| limit_time_enabled | No | Enable a time window during which the quiz is available. | |
| report_row_options | No | Report row options: sort_mode (default, asc, desc) and value_format (both, count, percent). null returns the standard behaviour. | |
| results_appearance | No | Report appearance of this quiz: palette_id, custom_colors, bar_color_mode, font_family, show_value_labels, show_grid_lines. null returns the standard look. Passing this object also turns results_appearance_use_shared off — otherwise the colors would not apply, because the shared account palette wins. Allowed values and the current account palette: get_workspace_report_appearance. | |
| schedule_time_from | No | Start of the availability window in H:i format (e.g. "09:00"). Interpreted in schedule_timezone. | |
| anonymous_responses | No | Anonymous responses: do not store respondent-identifying data. | |
| limit_message_title | No | Title of the message shown when the response limit is reached (max 500 characters). | |
| limit_time_timezone | No | Timezone for the availability limit (max 100 characters). | |
| limit_time_value_tz | No | Time value including timezone (max 50 characters). | |
| question_timer_mode | No | Per-question countdown timer: individual, all_enabled, or all_disabled. | |
| filling_time_enabled | No | Enable a timer for time allowed to complete the quiz. | |
| filling_time_seconds | No | Time allowed to complete the quiz in seconds (0–86400). | |
| question_random_mode | No | What random order shuffles: all — the whole quiz, groups — only questions marked with randomGroupId (each set is shuffled across its own positions). Defaults to all. | |
| session_check_method | No | Session validation methods: array of ip, cookie, extra_params. | |
| allow_multiple_answer | No | Allow submitting the quiz more than once (multiple completions). | |
| disable_auto_redirect | No | Disable automatic navigation after an answer. | |
| google_analytics_code | No | Google Analytics id (max 100 chars). | |
| question_random_order | No | Show questions in random order. | |
| repeat_interval_hours | No | Repeat after an interval: a person may fill in the quiz again only N hours (1–8760) after their previous completed answer. Works only with allow_multiple_answer: true; null — no interval. The person is recognised by session_check_method (cookie and/or ip). Cannot be combined with sso_active, require_email_verification or the extra_params check method. | |
| report_merge_versions | No | Merge question versions in the report: answers collected by different quiz versions are shown as one block. | |
| allow_restart_progress | No | Let a returning respondent start over instead of continuing an unfinished attempt. Works only together with auto_save_progress. | |
| question_min_view_mode | No | Minimum question view time before moving forward: individual, all_enabled, or all_disabled. | |
| question_required_mode | No | How required questions work: individual, all_required, or all_optional. | |
| question_timer_seconds | No | Question timer duration in seconds (when question_timer_mode=all_enabled). | |
| limit_answer_count_mode | No | What counts toward the response cap: all (every record, including abandoned ones), completed (finished, screened-out included), completed_no_screenout (finished without screened-out). Default for new quizzes: completed. | |
| scripts_in_body_enabled | No | Enable executing scripts in body. | |
| scripts_in_head_enabled | No | Enable executing scripts in head. | |
| google_analytics_version | No | Google Analytics version (max 20 chars). | |
| limit_answer_count_value | No | Maximum number of responses (0–1000000). | |
| qr_code_background_color | No | QR code background color (max 50 characters). | |
| block_jump_to_prev_widget | No | Block going back to the previous question (widget). | |
| question_lock_answer_mode | No | Lock answer after responding: individual, all_enabled, or all_disabled. | |
| question_min_view_seconds | No | Minimum view time in seconds (when question_min_view_mode=all_enabled). | |
| google_analytics_is_active | No | Send events to Google Analytics. | |
| limit_answer_count_enabled | No | Enable a cap on the maximum number of responses (completions). | |
| multilogic_sequential_mode | No | Sequential multi-logic: several condition groups on one question are applied in order rather than only the first matching one. | |
| question_timer_button_mode | No | Show question on button click: individual, all_enabled, or all_disabled. | |
| require_email_verification | No | Require e-mail verification before the answer is submitted. | |
| closed_quiz_message_enabled | No | Enable the closed-quiz message. | |
| results_appearance_use_shared | No | Follow the shared report palette of the account (update_workspace_report_palette). true — the quiz renders reports with the account palette; its own colors stay in place and come back when this is turned off. | |
| anonymous_responses_show_label | No | Show the respondent a label saying the quiz is anonymous. |