Skip to main content
POST
Create a new session

Authorizations

Authorization
string
header
required

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

Headers

project
string
required

Body

application/json
gleapId
string

Read-only; generated by the server, ignored on create/update.

gleapHash
string

Read-only; generated by the server, ignored on create/update.

lang
string

Contact language. Ignored by POST /sessions for new email/guest sessions (created with "en"); settable via the SDK identify call or session update.

firstActivity
any
lastHeardFrom
any
lastActivity
any
lastFeedbackReport
any
project
string

Read-only; derived from the project header, ignored if sent.

organisation
string

Read-only; derived from the project header, ignored if sent.

unsubscribed
boolean
unsubscribedAt
any
unsubscribeReason
string
lastPageView
any
userId
string
name
string
location
any
email
string
avatar
string
companyId
string
emailOnly
boolean
companyName
string
deviceType
string
platform
string
sla
number<double>
phone
string
blocked
boolean
plan
string
value
number<double>
sessions
number<double>

Read-only; server-maintained counter.

facebookId
string
instagramId
string
instagramUsername
string
telegramChatId
string
telegramUsername
string
outboundHistory
any
countFeedbackReports
number<double>
countFeedbackComments
number<double>
tags
string[]
checklistTasks
any
customData
any
eventData
any

Response

200 - application/json

Ok