Skip to main content

Create Session Request

Request body for creating a new session. The structure varies based on the channel type.

languagestring

Language code for the session

Example: EN
embeddedData object

Embedded data variables

property name* object
anyOf
string
channelstring

Channel type for the session (optional - if not provided, defaults to anonymous behavior)

Possible values: [anonymous, distribution, eiLink]

distribution object

Distribution settings for distribution-based sessions (only required when channel is 'distribution')

recipientIdstring

Recipient identifier

Example: CGC_123456789
distributionIdstring

Distribution identifier

Example: EMD_123456789
eiLink object

EI Link settings for EI Link sessions (only required when channel is 'eiLink')

projectIdstring

Project identifier (Q_TS_ID)

Example: TS_123456789
personIdstring

Person identifier (Q_TS_PID)

Example: P_123456789
relationshipstring

Relationship type (Q_TS_RS)

Example: Self
evaluatorIdstring

Evaluator identifier (Q_TS_RE_PID)

Example: P_123456789
anonymousboolean

Whether to anonymize the session (Q_EE_ANON)

Example: true
unsolicitedboolean

Whether the session is unsolicited (Q_TS_UNSOL)

Example: true
stripHTMLboolean

Whether to strip HTML from responses

Default value: false
questionsPerPageinteger<int32>

Number of questions to display per page

Possible values: >= 1 and <= 100

Example: 1
Create Session Request
{
  "language": "EN",
  "embeddedData": {
    "customVar": "value",
    "userId": "12345"
  },
  "channel": "anonymous",
  "distribution": {
    "recipientId": "CGC_123456789",
    "distributionId": "EMD_123456789"
  },
  "eiLink": {
    "projectId": "TS_123456789",
    "personId": "P_123456789",
    "relationship": "Self",
    "evaluatorId": "P_123456789",
    "anonymous": true,
    "unsolicited": true
  },
  "stripHTML": false,
  "questionsPerPage": 1
}