API ReferenceSurveys

Create Survey

Creates a schema for survey, which includes name and description of schema.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
namestringRequiredformat: "text">=1 character<=100 characters
The survey's name.
descriptionstringOptionalformat: "text"<=1000 characters
Description about the survey.
headerstringOptionalformat: "text"<=1000 characters
Header of the survey.
introductory_textstringOptionalformat: "text"<=1000 characters
Text posted when introducing the survey to the responder.
response_textstringOptionalformat: "text"<=1000 characters
Text posted after the response is collected.
schemalist of objectsOptional
Schema for the survey.
schema_with_metadatalist of objectsOptional
The schema with metadata for the survey.
titlestringOptionalformat: "text"<=1000 characters
Title of the survey.

Response

Success.
surveyobject

Errors