Update form settings
update_form_settingsChange how a form of the current team is delivered, as opposed to what it says (use update_form for title / questions / report / theme). Editable: submissionAccess (who may answer and whether seeing the report needs a login — this is the lead-capture gate), reportGateRequireCode (whether that login gate collects an emailed verification code, trading completion rate against lead quality), timeLimit, sharing (the result-page share button and personalised share card, which is what drives organic spread), answerSheet, crowdCompare (show respondents what share of people picked the same option — off by default, not for knowledge quizzes), instantFeedback (knowledge quizzes only, on by default for newly created ones except level tests: respondents submit each page and see right / wrong, the correct answer and the explanation before moving on), hideScores (hide every score respondents see — report, question points, instant feedback and answer review — while keeping levels and right / wrong), booking (the result-page block that opens the team's Cal.com scheduling link; bookings sync back read-only), feedback (a one-question feedback block on the result page), allowPdfDownload (respondents can download their full report as a PDF — Pro), resultRedirect (send respondents straight to a link chosen by their score level or outcome after they submit, instead of the result page — Pro), defaultCta (the result-page CTA master switch plus the default button for results without their own), hiddenFields (URL parameters such as partner or campaign_id captured with each response for attribution), searchIndexable (whether search engines may list the quiz), and slug (the custom path that gives the public link a memorable, SEO-friendly address). Only the keys you pass are changed. Read the current values with get_form_share_info.
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": {
"formId": "<formId>"
},
"name": "update_form_settings"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | No | Custom path of the public answer link — the SEO-friendly address (e.g. quizster.app/<team>/burnout-test on the platform domain, or <custom-domain>/burnout-test when the team's custom domain is serving). Lowercase letters, digits and hyphens, 2-64 chars, must start and end with a letter or digit, unique within the team. Pass an empty string to clear back to the random address. Changing it breaks the previous custom path right away, but the token address (/a/<publicToken>) always keeps working and the page's canonical URL follows the custom path. | |
| formId | Yes | The form UUID | |
| booking | No | The result-page booking block: switch, copy and the Cal.com link respondents book through. With the team's Cal.com connector, bookings flow back and show up in list_bookings. Without a calLink the block is not shown, even when enabled. | |
| sharing | No | Result-page sharing: the share button, the personalised share card and the public summary. Turning this off stops respondents spreading their results. | |
| feedback | No | Result-page feedback block: one question asked after respondents read their report — tells you whether the result landed. Replaced WHOLESALE: read the current block from get_form_share_info and pass every key you want to keep (omitted copy falls back to the default, omitted choices are dropped). | |
| timeLimit | No | Answer-time countdown. Only knowledge quizzes (knowledge_quiz) can turn this on — a countdown makes sense when unanswered means wrong, but rushing a scorecard or a personality quiz just produces careless answers. | |
| defaultCta | No | Result-page CTA buttons. This is the master switch: while it is off no result shows a CTA, not even levels / outcomes / AI result tags that have their own. Passing an object turns it on and replaces the default button (text + url), which every result without its own cta uses — pass {} to turn it on with no default, so only results with their own cta show a button. null turns it off and keeps the copy. Per-result buttons are set with update_form (writing one also turns this on). For AI quizzes the button appears below the AI report. Free on every plan. | |
| hideScores | No | Hide every score the respondent sees: the result page's overall score (score ring / number / percentile) and every dimension score, the points badge on each question while answering, the score in instant feedback, and the per-question scores in the answer review. Level names, level descriptions, the summary and right / wrong verdicts stay. The team still sees scores in the dashboard. Scenes with scores only (knowledge_quiz / scored_quiz). Note the summary template still renders its score variable if one is left in. Off by default. | |
| answerSheet | No | The answer-sheet sidebar on the answering page: a question navigator that lets respondents jump to any question. On by default for newly created forms; turn it off for short quizzes meant to be answered straight through to the result page. | |
| crowdCompare | No | Show respondents what share of people picked the same option ("62% of people chose the same as you"). Off by default: it publishes this quiz's answer distribution to whoever answers it, and seeing the majority choice nudges later respondents toward it — leave it off for quizzes used to match courses or place learners. Percentages only, never individual answers, and nothing shows until the quiz has 10+ submissions. Not available for knowledge quizzes at all: the distribution is effectively a crowdsourced answer key. | |
| hiddenFields | No | URL parameters to capture with each response (hidden fields), e.g. ["partner", "campaign_id"]: opening the quiz link with ?partner=acme stores partner=acme on the record, where it shows in record detail, exports and webhook / Zapier payloads. Lowercase names, up to 10; utm_* and system names (email, name, lang, ref, embed…) are reserved. Replaces the whole list; null or [] clears it. | |
| resultRedirect | No | Redirect after submission (Pro): respondents go straight to a link instead of the result page — after the login / lead gate if the report has one. The per-result links live on report.levels[i].redirectUrl (knowledge / scored quizzes) and report.outcomes[i].redirectUrl (outcome quizzes), set with update_form. Shared result links and return visits still open the result page. Only the keys you pass change. | |
| instantFeedback | No | Knowledge quizzes only (knowledge_quiz). When on, the respondent submits each page on its own and sees whether they were right, the correct answer and the question's explanation; submitted questions lock before they move on, and the last page ends with a "See results" button that finishes the quiz. On by default for newly created knowledge quizzes except level tests (useCase level_test); existing quizzes keep whatever they had. Turns the quiz into a learn-as-you-go challenge; it does reveal answers question by question, so leave it off when the score is used for placement. | |
| searchIndexable | No | Whether search engines may list this quiz: true puts it in the sitemap and marks its public pages indexable, false keeps them out of search results (drafts, funnel pages meant only for one audience). New quizzes default to true. | |
| allowPdfDownload | No | Let respondents download their full report as a PDF. Pro only (switching it on is rejected on the Free plan). Takes effect only on gated quizzes (submissionAccess login_to_view_report) because the download is tied to the signed-in respondent. | |
| submissionAccess | No | public = anyone answers and sees the report; login_to_view_report = anyone answers but must sign in to see the report (the default, this is how leads get captured) | |
| reportGateRequireCode | No | Only applies when submissionAccess is login_to_view_report. false (the default for newly created quizzes) = the respondent only types an email and a name to see this one result — far more people finish, but the address is unverified and they get no account, and since result links do get forwarded, the report is effectively as reachable as public for whoever opens the link first. true = the respondent must confirm an emailed 6-digit code, so every captured lead has a verified address and the respondent gets an account they can return to. Quizzes created before this setting existed read as true. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | No | Custom path after this change; null when cleared (back to the random address) | |
| formId | No | The form that was changed | |
| changed | No | Which settings this call changed | |
| delivery | No | Delivery state: { isActive, submissionAccess, reportGateRequireCode, timeLimit, sharing, answerSheet, crowdCompare, instantFeedback, hideScores, booking, feedback, allowPdfDownload, resultRedirect, defaultCta, hiddenFields, searchIndexable } |