Skip to content

Support

support_survey_unpublish

Return a published survey to draft so it can be edited.

Tool

support_survey_unpublish

Return a published survey to draft so it can be edited.

Return a published survey to draft so it can be edited. It stops accepting responses immediately; the responses already collected are untouched. A survey that is not published is refused

Behavior

HTTP
POST /support/surveys/:id/unpublish

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

Return a published survey to draft so it can be edited.

When to use

Return a published survey to draft so it can be edited. It stops accepting responses immediately; the responses already collected are untouched. A survey that is not published is refused

Example

Ask your agent something like this:

Return a published survey to draft so it can be edited.

The agent will invoke support_survey_unpublish with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect