v5

latestOpenAPI 3.0.02026-08-04258282491.7 KB

Session

Create a new session

Create a session (contact) in the project from the project header. When userId is supplied this is an upsert: an existing contact with that userId is updated and returned instead of a new one being created (one session per project + userId). Without userId a new guest/email session is always created.

post/sessions

Headers

projectstring required

Request body

gleapIdstring

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

gleapHashstring

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

langstring

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

{"stackTrail":"components:schemas:SessionDto:properties:firstActivity","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:SessionDto:properties:lastHeardFrom","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:SessionDto:properties:lastActivity","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:SessionDto:properties:lastFeedbackReport","oasType":"schema","type":"unknown"}

projectstring

organisationstring

unsubscribedboolean

{"stackTrail":"components:schemas:SessionDto:properties:unsubscribedAt","oasType":"schema","type":"unknown"}

unsubscribeReasonstring

{"stackTrail":"components:schemas:SessionDto:properties:lastPageView","oasType":"schema","type":"unknown"}

userIdstring

namestring

{"stackTrail":"components:schemas:SessionDto:properties:location","oasType":"schema","type":"unknown"}

emailstring

avatarstring

companyIdstring

emailOnlyboolean

companyNamestring

deviceTypestring

platformstring

slanumber double

phonestring

blockedboolean

planstring

valuenumber double

sessionsnumber double

Read-only; server-maintained counter.

facebookIdstring

instagramIdstring

instagramUsernamestring

telegramChatIdstring

telegramUsernamestring

{"stackTrail":"components:schemas:SessionDto:properties:outboundHistory","oasType":"schema","type":"unknown"}

countFeedbackReportsnumber double

countFeedbackCommentsnumber double

tagsstring[]

{"stackTrail":"components:schemas:SessionDto:properties:checklistTasks","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:SessionDto:properties:customData","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:SessionDto:properties:eventData","oasType":"schema","type":"unknown"}

Response

{"stackTrail":"paths:/sessions:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}