v16

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-0124102197.4 KB
V3 Surveys

Archive a survey

Archives (soft-deletes) a survey by id. Archived surveys are hidden from the default list, stop collecting responses, and become read-only until restored — a subsequent PATCH returns 422. Works on any survey, including legacy question-based surveys, so this endpoint returns a minimal lifecycle acknowledgement rather than the full survey resource. Session cookie or x-api-key.

post/api/v3/surveys/{surveyId}/archive

Path parameters

surveyIdstring cuid2 required

Survey identifier.

Response

Survey archived successfully