Skip to navigation
v2Apps

Create a new app session

Create a new app session. Sessions cannot be archived once created.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
appIdstringRequired
namestringRequired3-100 characters

The name of the session. Length must be between 3-100 chars. Value is required and immutable once set.

timeoutSecondsintegerRequired1-2592000
Timeout in seconds, a value between 1 second and 30 days. Once set, it can only be increased, not decreased.
messageslist of objectsOptionalDefaults to []

An array of SessionMessage describing the current session state.

Response

Created
appobjectOptional
createdAtdatetimeOptional
idstringOptional
messageslist of objects or nullOptional

An array of SessionMessage describing the current session state.

modifiedAtdatetimeOptional
namestringOptional3-100 characters

A brief description of the app’s actions for users. Length must be between 3-100 chars. It becomes immutable once a value is set.

statusenumOptional

All possible values of a Session’s status, including system-updated and user-updated values.

Allowed values:
timeoutSecondsintegerOptional1-2592000
Timeout in seconds, a value between 1 second and 30 days. Once set, it can only be increased, not decreased.

Errors

400
Bad Request Error
403
Forbidden Error