Pause Survey
pause_surveyPauses a survey: a RUNNING survey stops accepting NEW responses. HIGH-CONSEQUENCE action on a live survey — get the user's EXPLICIT consent before calling with confirm:true; call WITHOUT confirm first, which is a read-only PREVIEW with zero side effects (live state, response counts, concurrency slots), and show the user what pausing means. Pausing is REVERSIBLE — publish_survey re-starts the SAME publication and collection resumes into the SAME dataset (PublicationID unchanged, nothing deleted). Respondents currently mid-response will finish and be saved — only NEW entries are closed; a new visit to the share link sees the survey-closed page. Pausing frees one of the concurrent-survey slots. Guards: a never-published survey is refused ('there is nothing to pause'); pausing an already stopped survey (including one that auto-closed) is idempotent success with wasAlreadyStopped. The paused state is verified server-side by re-reading the publication before success is reported.
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. | |
| confirm | No | Omit or false → read-only preview of what pausing would do, NO change is made. true → actually pause the survey (only after the user explicitly agreed). |
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. |