Skip to content

Support

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

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

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.

navigateselect