Set Survey
set_surveyAdd or replace a Survey block’s questions. Omit blockId to append with a server-assigned ID, or use an existing Survey ID to edit. Returns blockId for new surveys. Other blocks are preserved. No launch.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| testId | Yes | ||
| blockId | No | Omit to append a new survey with a server-assigned ID. Supply an existing survey ID to edit. | |
| questions | Yes | Follow-up survey questions capture judgments, comparisons, friction and what the researcher wants to learn. Use explicit question objects with unique id, type, question and required fields. open_ended needs question text; multiple_choice, ranking and budget_allocation need at least two non-empty options. allowMultiple applies to multiple_choice. rating needs scaleMin < scaleMax; rating and ranking require scaleLabels.min and scaleLabels.max naming the endpoints. budget_allocation asks testers to split 100 points across options. yes_no asks for a yes/no answer. At most 10 questions per Survey; launch preview reports plan and test-wide limits. | |
| expectedRevision | No | Legacy compatibility only; ignored. Draft revisions are resolved automatically. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Open the draft in Uxia. | |
| testId | No | ||
| blockId | No | Server-assigned ID of the added block. Use it for subsequent edits and references. | |
| editable | No | ||
| definition | Yes |