Question Types

The developer page examples include these question types:

requireAnswer defaults to false when omitted.

Star Rating

Required properties:

• title (string)
• length (number)

Optional properties:

• color (string)
• half (boolean)
• requireAnswer (boolean, default: false)

Example properties:

{
  "title": "How would you rate us?",
  "length": 5,
  "color": "#F5A623",
  "half": false,
  "requireAnswer": true
}

Multiple Choice

Required properties:

• title (string)
• choices (array of strings)

Optional properties:

• multiSelect (boolean)
• requireAnswer (boolean, default: false)

Example properties:

{
  "title": "Who is your favorite trainer?",
  "choices": ["Jeff", "Tom", "Cindy", "Jennifer"],
  "multiSelect": false,
  "requireAnswer": false
}

Comment Box

Required properties:

• title (string)

Optional properties:

• requireAnswer (boolean, default: false)

Example properties:

{
  "title": "Please leave us your feedback.",
  "requireAnswer": false
}

Error Responses

When question type or properties are invalid, the API returns:

{
  "error": "invalid_request"
}

Example invalid question type request:

{
  "type": "Slider",
  "properties": {
    "title": "Rate us"
  }
}

Example invalid properties request:

{
  "type": "Star Rating",
  "properties": {
    "title": "Rate us"
  }
}