API ReferenceSurveys

Update Survey

Updates a survey's metadata.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
idstringRequiredformat: "id"
The ID of the survey to update.
descriptionstringOptionalformat: "text"<=1000 characters
The updated description about the survey.
headerstringOptionalformat: "text"<=1000 characters
Header of the survey.
introductory_textstringOptionalformat: "text"<=1000 characters
The updated text posted when introducing the survey to the responder.
namestringOptionalformat: "text">=1 character<=100 characters
The survey's updated name.
response_textstringOptionalformat: "text"<=1000 characters
Text posted after the response is collected.
schema_with_metadatalist of objectsOptional
The updated schema with metadata for the survey.
titlestringOptionalformat: "text"<=1000 characters
Title of the survey.
surveystringOptionalformat: "id"Deprecated
The ID of the survey to update.

Response

Success.
surveyobject

Errors