{ "ok": true } without error. This makes it safe to call multiple times or from multiple clients without special-casing the response.
Cancelling a session does not delete it. To remove the session and its events permanently, use the Delete Session endpoint.
Request
The ID of the session to cancel. You can obtain this from the Create Session response or the List Sessions endpoint.
Response
Always
true when the cancellation request is accepted.Present and
true when the session had already been cancelled before this request. The cancellation timestamp was not updated.Example
Idempotent response (already cancelled)
Errors
| Status | Meaning |
|---|---|
400 | The sessionId field is missing, empty, or malformed. |
401 | The request is not authenticated. Ensure your session cookie is valid and has not expired. |
404 | No session with the given ID was found for your user and organisation. |
429 | Cancel burst rate limit exceeded (30 requests per minute per user). The response includes a Retry-After header. |