Cancel consultation

Closes a SOFT Integration session that is still open, identified by the requestId you generated when requesting the signature.

A physician can only have one active consultation at a time, and issuing a new signature already cancels the previous one. Use this endpoint when you want to release the physician without opening a new consultation: for example when the appointment is cancelled, or when the physician closed the browser and you want the session closed right away instead of leaving it alive until its signature expires.

Request description

Endpoint: /api/v1/soft-integration/{requestId}
Method: DELETE

Path parameters

Parameter	Required	Description
`requestId`	Yes	The identifier you sent when generating the signature for this consultation.

{
  "Authorization": "Bearer <accessToken>"
}

The access token is the same one used to generate the signature. Access is scoped to the organization that owns the consultation: a token from a different organization is rejected.

To set the API version on a specific request, you can add a specific header named X-Invox-Medical-Api-Version with the value of the version you are targeting:

X-Invox-Medical-Api-Version: 2026-08-01

2026-08-01 is the only version this endpoint accepts. Omitting the header resolves to the latest version.

Effects

Effect	Detail
The physician is released	They can immediately be issued a new signature for another consultation.
The signature stops working	It can no longer open Invox Genesis nor the notification WebSocket.
No result is produced	A cancelled consultation never emits `OnMedicalReportFinished`.
The `requestId` stays reserved	It cannot be reused. Generate a new one for the next consultation.

Cancelling is final. There is no way to resume a cancelled consultation. Use it only when the physician has abandoned the session, never as a way to interrupt a consultation in progress.

Do not retry with the same requestId. Cancelling releases the physician, not the identifier. Asking for a new signature with the requestId you just cancelled is rejected with 400 and duplicatedRequestId.

A consultation that already finished cannot be cancelled: it responds 409. Its result remains retrievable with Get consultation result until it expires.

Responses

Correct response

Successful request

Describe the characteristics of a satisfactory response

200

Response structure:

{
  "requestId": "2222-2222-2222-2222",
  "organizationId": "1111-1111-1111-1111",
  "cancelled": true
}

Wrong responses

Unauthorized request

Describe the characteristics of an unauthorized request

401

Response body

{
  "message": "Unauthorized"
}

Description: no valid credential was supplied.

Forbidden request

Describe the characteristics of a forbidden request

403

Response body

{
  "message": "The requested consultation belongs to another organization.",
  "errorType": "invalidPermission"
}

Description: the requestId exists but belongs to a different organization, or the API Key does not hold the GENESIS-SOFT-INTEGRATION permission.

Not found

Describe the characteristics of a request for an unknown consultation

404

Response body

{
  "message": "No consultation found for the provided requestId.",
  "errorType": "requestNotFound"
}

Description: no consultation exists for that requestId. Check that you are sending the same identifier used to generate the signature.

Conflict

Describe the characteristics of a request for an already finished consultation

409

Response body

{
  "message": "The consultation is already finished.",
  "errorType": "sessionAlreadyFinished"
}

Description: the consultation already finished or was cancelled before. Nothing changes.

DocsGet consultation result

NotificationsOverview