Skip to main content
DELETE
Delete a session
Safety
  • Writes data: Yes. Moves the session and its notes to the recycle bin. It is not a permanent delete: restore it with Restore a deleted session. Emptying the recycle bin is only possible in the dashboard.
  • Safe to retry: Yes. A repeat finds the session already in the bin, changes nothing and returns changed: false.
  • Contacts an outside system: None. Notes already sent to an EHR stay there.
  • Dry run: Not available.
Rolling out: this endpoint is on staging first and not yet on api.healos.ai.
A deleted session no longer appears in GET /sessions/{sessionId} or the notes endpoints. Another organization’s session is a 404. Guide: Making requests. Errors: Error catalog.

Authorizations

X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Path Parameters

sessionId
string
required

Session UUID

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Response

The session is in the recycle bin

data
object
required