Skip to content

Support

support_survey_update

Edit a survey’s name or question set.

Tool

support_survey_update

Edit a survey’s name or question set.

Edit a survey’s name or question set. Only a draft is editable — publishing freezes the structure, because answers are keyed by question id and rewriting the questions under them would change what every collected response was answering. To edit a live survey, unpublish it first. questions replaces the whole set; pass an empty array to clear it

Behavior

HTTP
PATCH /support/surveys/:id

Arguments

NameTypeRequiredDescription
idstringSurvey id
namestringNew name
questionsarrayThe complete new question set, replacing the old one. Pass [] to empty the draft

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

Edit a survey’s name or question set.

When to use

Edit a survey’s name or question set. Only a draft is editable — publishing freezes the structure, because answers are keyed by question id and rewriting the questions under them would change what every collected response was answering. To edit a live survey, unpublish it first. questions replaces the whole set; pass an empty array to clear it

Example

Ask your agent something like this:

Edit a survey’s name or question set.

The agent will invoke support_survey_update with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect