Skip to content

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

Name
Type
Required
Description
id
string
•
Survey id

Response

Field
Type
Always
Description
id
string
•
Survey id
name
string
•
What this survey is called
status
string
•
draft: editable, not answerable. published: answerable, frozen. archived: terminal, neither editable nor answerable, and there is no way back
createdAt
string
•
ISO-8601 creation timestamp
questions
array
•
The ordered question set, exactly as stored
updatedAt
string
•
ISO-8601 last-modification timestamp
questionIds
array
•
The same questions as a flat list of ids, in the order they are asked
questionCount
integer
•
How many questions this survey asks — the same field support/survey.published carries, so a workflow built from the trigger and one built from a get-step bind one shape

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.

↑↓navigate↵select