Skip to content

support_survey_publish

Publish a draft survey, which is what makes it answerable and what freezes its structure.

Tool

support_survey_publish

Publish a draft survey, which is what makes it answerable and what freezes its structure.

Publish a draft survey, which is what makes it answerable and what freezes its structure. Publishing validates the whole question set: it must be non-empty, question ids must be unique, radio and checkbox questions must offer options, a statement may not be required, and every skip must target a later question or the literal "end". A survey that is already published or archived is refused

Behavior

HTTP
POST /support/surveys/:id/publish

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

Publish a draft survey, which is what makes it answerable and what freezes its structure.

When to use

Publish a draft survey, which is what makes it answerable and what freezes its structure. Publishing validates the whole question set: it must be non-empty, question ids must be unique, radio and checkbox questions must offer options, a statement may not be required, and every skip must target a later question or the literal "end". A survey that is already published or archived is refused

Example

Ask your agent something like this:

Publish a draft survey, which is what makes it answerable and what freezes its structure.

The agent will invoke support_survey_publish with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select