update_survey_options
Patch Qualtrics survey options safely by merging with current settings; use replace=true to overwrite entirely.
Instructions
Safely patch survey options. By default the current options are fetched and recursively merged before PUT so omitted settings are preserved. Set replace=true only to submit exactly the supplied options and intentionally reset or remove omitted settings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skin | No | Skin object, including brandingId, templateId, and overrides | |
| footer | No | Survey footer HTML | |
| header | No | Survey header HTML | |
| noIndex | No | Search-index setting, commonly Yes or No | |
| options | No | Raw Qualtrics options patch; supports every current or future option field | |
| replace | No | Submit only supplied fields instead of safely merging with current options (default: false) | |
| surveyId | Yes | The Qualtrics survey ID | |
| backButton | No | Enable or disable the BackButton option | |
| nextButton | No | Next-button label | |
| externalCss | No | ExternalCSS value | |
| partialData | No | Partial-response retention setting, such as +1 week | |
| customStyles | No | Custom survey CSS stored in CustomStyles | |
| pageTransition | No | Page transition mode | |
| previousButton | No | Previous-button label | |
| surveyLanguage | No | Primary SurveyLanguage code | |
| saveAndContinue | No | Enable or disable Save and Continue | |
| questionsPerPage | No | QuestionsPerPage option in the form accepted by the brand | |
| surveyProtection | No | Survey protection mode, such as PublicSurvey or ByInvitation | |
| anonymizeResponse | No | AnonymizeResponse option, commonly Yes or No | |
| surveyTermination | No | Survey termination mode | |
| availableLanguages | No | AvailableLanguages options object | |
| endOfSurveyMessage | No | EOSMessage HTML/text | |
| progressBarDisplay | No | Progress-bar display mode, such as None, Text, or Verbose | |
| endOfSurveyRedirectUrl | No | EOSRedirectURL | |
| ballotBoxStuffingPrevention | No | Enable or disable ballot-box-stuffing prevention |