Skip to content

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

Name
Type
Required
Description
id
string
•
Survey id
name
string
—
New name
questions
array
—
The complete new question set, replacing the old one. Pass [] to empty the draft

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

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.

↑↓navigate↵select