clients

Delete a client (owner)

Permanently deletes the client (owner) and every patient it owns. Consultations of those patients are kept, with their recordings, transcripts and notes, but lose their patient and owner link. Cannot be undone. Requires the workspace admin or superadmin role (or organization admin access); other members get 403, even for an unknown id. Returns 404 when the client does not exist.

delete/workspaces/{workspaceId}/clients/{clientId}

Request

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

Path parameters

workspaceIdstring required

Identifier of the workspace (clinic) that owns the patients and clients. The caller must be a member of it; patients and clients are shared by all members of the workspace.

Example:furunculotic-loud-chihuahua
clientIdstring required

Client (owner) id (UUID) in this workspace. Unknown ids and ids from other workspaces return 404.

Example:e1f2a3b4-c5d6-4789-efab-901234567890

Response

Empty object confirming the client was deleted.

object required

Empty object returned on successful deletion.

Changes

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