Freeze session

Use this endpoint to freeze a chat session, temporarily suspending its automatic closing by TTL. The freeze is lifted automatically as soon as an operator sends a message in the session, or it expires on its own once the freeze period ends. If both freezeUntil and freezeSeconds are passed, freezeUntil takes priority and freezeSeconds is ignored. The freeze period must not be in the past and cannot exceed 7 days from now.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of an existing chat session.

Body Params
string

Date/time to freeze the session until. Takes priority over freezeSeconds if both are set.

integer

Number of seconds to freeze the session for, counted from now. Ignored if freezeUntil is set.

Responses
200

Successful operation

400

Invalid input parameters

401

User is not authenticated

404

Entity not found

422

Invalid entity state

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json