delete_survey
Permanently delete a survey. IRREVERSIBLE — deletes the survey, its questions, ALL collected responses, stats and uploaded files. NEVER call without explicit user confirmation for this specific survey, spelling out what will be lost. If the survey has responses the API additionally requires confirm=true (409 otherwise) — only pass confirm=true after the user explicitly accepted losing the responses. Participants created from the survey and the sweepstakes itself are preserved. To disable a survey WITHOUT losing data, use update_survey with status false instead — always offer that alternative first. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support.
delete_survey
When to use
Permanently delete a survey. IRREVERSIBLE — deletes the survey, its questions, ALL collected responses, stats and uploaded files. NEVER call without explicit user confirmation for this specific survey, spelling out what will be lost. If the survey has responses the API additionally requires confirm=true (409 otherwise) — only pass confirm=true after the user explicitly accepted losing the responses. Participants created from the survey and the sweepstakes itself are preserved. To disable a survey WITHOUT losing data, use update_survey with status false instead — always offer that alternative first. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support.
Pre-calls required
get_survey— check ResponsesCount and tell the user exactly what will be lost
Parameters to validate before calling
survey_token(string, required) — The survey token (UUID v4) of the survey to deleteconfirm(boolean, optional) — Required true ONLY when the survey already has responses. Pass it ONLY after the user explicitly confirmed losing all responses
Notes
DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.
Deletes questions, ALL responses, stats and uploaded files. Participants created from the survey are preserved
confirm: trueis required when responses exist — pass it ONLY after the user explicitly accepted losing themOffer update_survey with status false first (disable without data loss)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | Required true ONLY when the survey already has responses. Pass it ONLY after the user explicitly confirmed losing all responses | |
| survey_token | Yes | The survey token (UUID v4) of the survey to delete |