Update Session Request

Request body for updating a session

navigationstringrequired

Navigation command for the session

Possible values: [next, previous, saveProgress, close]

Example: next

responses object

User's answers for the session, keyed by question ID

property name* Question Answer

Union of all supported question answer types. Documentation provided for reference; validation is permissive.

anyOf

• object
• Form Answer
• Matrix Answer
• Multiple Choice Answer
• Net Promoter Score Answer
• Rank Order Answer
• Slider Answer
• Text Entry Answer

object

Generic catch-all for complex answer types

embeddedData object

Embedded data variables

property name* object

anyOf

• string
• number<double>
• boolean

string

Update Session Request

{
  "navigation": "next",
  "responses": {},
  "embeddedData": {
    "customVar": "value",
    "userId": "12345"
  }
}