Skip to main content

StartNewSessionRequestBody

languagelanguage (string)

Language code that defines which translations are used. Language code must be one of the available languages defined in the survey.

Example: EN
embeddedData object

Any embedded data to set on the survey session.

property name*embeddedDataValue (string)
recipientIdrecipientId (string)

Used to tie the response to a panel member.

Example: MLRP_1234567890
distributionIddistributionId (string)

Used to tie the response to a unique link. If distributionId is defined, recipientId must also be defined.

Example: EMD_1234567890
StartNewSessionRequestBody
{
  "language": "EN",
  "embeddedData": {
    "edKey": "edValue",
    "customerName": "Kyle"
  },
  "recipientId": "MLRP_1234567890",
  "distributionId": "EMD_1234567890"
}