Skip to content

Support

support_survey_archive

Switch a survey off for good, from either draft or published.

Tool

support_survey_archive

Switch a survey off for good, from either draft or published.

Switch a survey off for good, from either draft or published. Archiving is terminal — there is no way back in v2 — and it deletes nothing: every response already collected stays readable

Behavior

HTTP
POST /support/surveys/:id/archive

Arguments

NameTypeRequiredDescription
idstringSurvey id

Response

FieldTypeAlwaysDescription
idstringSurvey id
namestringWhat this survey is called
statusstringdraft: editable, not answerable. published: answerable, frozen. archived: terminal, neither editable nor answerable, and there is no way back
createdAtstringISO-8601 creation timestamp
questionsarrayThe ordered question set, exactly as stored
updatedAtstringISO-8601 last-modification timestamp

Try it

Switch a survey off for good, from either draft or published.

When to use

Switch a survey off for good, from either draft or published. Archiving is terminal — there is no way back in v2 — and it deletes nothing: every response already collected stays readable

Example

Ask your agent something like this:

Switch a survey off for good, from either draft or published.

The agent will invoke support_survey_archive with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect