[BETA] Replace survey template

Fully replaces a survey template (metadata + content) by its internal id or external reference id. The survey body is the same SurveyJS schema as on create and entirely replaces the previous version. Same scope rules as create (allowed types, no quiz/conditional logic, rateMin < rateMax, ≥ 1 question, size limits) — a rejected request writes nothing. externalReferenceId/externalReferenceType are the exception to the full replace: when absent they are kept unchanged; if externalReferenceId is set to null (or "") → its value is reset; to change it, provide both fields together. externalReferenceId must stay unique among the school templates (active or archived) — duplicate → 409 SURVEY_TEMPLATE_ALREADY_EXISTS. Replacing an archived template → 409 ARCHIVED_SURVEY_TEMPLATE_EXISTS; unknown template → 404 SURVEY_TEMPLATE_NOT_FOUND. Fires the SURVEY_TEMPLATE_EDITED webhook on success.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Internal survey template id

Body Params
survey
object
required

SurveyJS schema: { title, description?, pages: [{ elements: [...] }] }

boolean

Whether responses are anonymous (default: false)

string | null

External reference ID. Absent → unchanged; if set to null (or "") → its value is reset.

string | null

External reference type. Required when setting externalReferenceId.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json