Skip to navigation

Delete Session

View as Markdown

Permanently delete a finished session and everything it read.

Key technical details:

  • Irreversible. The session, its connections and their data are deleted and cannot be recovered; afterwards every read answers 404, exactly like a session that never existed.
  • Finished sessions only (409). An open session is refused with session_not_closed: cancel it first, or wait for it to end.
  • Concurrency lock (504). The deletion holds the session; if it cannot within a few seconds, retry.

This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

session_idstringRequiredformat: "object-id"
The session, as its creation returned it

Response

204 No Content
Deleted Successfully

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
504
Gateway Timeout Error