Skip to main content

Delete Consultation

deleteConsultation​

You can use the deleteConsultation method to delete a specific consultation by providing the consultation_id.

Parameters​

  • consultation_id: (number) - The ID of the consultation to delete.

Returns​

  • Promise<ResponseType<string>>: A promise that resolves on successful deletion.

Example​

import { deleteConsultation } from 'react-web-altibbi';

const response = await deleteConsultation(123);

Responses​

Status 204​

Success

Status 401​

UnauthorizedHttpException represents an Unauthorized HTTP exception with status code 401.

{
  "name": "Unauthorized",
  "message": "Your request was made with invalid credentials",
  "code": "0",
  "status": "401",
  "type": "yii\\web\\UnauthorizedHttpException"
}

Status 404​

Consultation ID invalid or deleted.

{
  "name": "Not Found",
  "message": "Object not found: {id}",
  "code": "0",
  "status": "404",
  "type": "yii\\web\\NotFoundHttpException"
}