VEvetnio
consultations

Archive a consultation

Archives the consultation. Nothing is erased: recordings, transcript, notes and uploaded files are kept, and the consultation stays readable by ID (GET .../consultations/{consultationId}, transcript and records). It disappears from GET .../consultations, but still appears in the admin export list. Archived consultations cannot be changed: write endpoints, including a second DELETE, return 403 with data.reason archived_consultation. Users can restore archived consultations in the Vetnio web app; permanent erasure is not available through the API. The clinic's audio-retention policy still removes audio on its normal schedule.

Any member of the workspace can archive any consultation in it. Returns 404 if the consultation does not exist in this workspace.

delete/workspaces/{workspaceId}/consultations/{consultationId}

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/consultations/{consultationId}
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Identifier of the clinic (workspace), as returned by GET /workspaces. The key's user must be a member of the clinic, or an admin of the organization it belongs to.

Example:furunculotic-loud-chihuahua
consultationIdstring required

Identifier of the consultation (UUID), as returned when it was created or by GET /workspaces/{workspaceId}/consultations. It must belong to the clinic in workspaceId.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Response

Consultation archived.

successboolean required

Always true when the consultation was archived.

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.