PUT /api/v1/appointments/:appointment_number/cancel

Cancels the appointment

Supported Formats

json

Errors

Code Description
404 Not found.
422 Unprocessable Entity.
500 Internal Server Error.

Examples

curl --location --request PUT 'https://app.octopi.co/api/v1/appointments/OCTOAPPT158409/cancel'   --header 'Authorization: Bearer token_value'   --header 'Content-Type: application/json'   --data-raw '{
  "cancellation_reason": "Cancellation from client side"
  }'

{
  "appointment_number": "OCTOAPPT158409",
  "appointment_slot_id": 584,
  "appointment_date": "2023-06-26",
  "appointment_timings": "03:00 PM - 04:00 PM",
  "status": "Cancelled",
  "truck": "TN01AN1982",
  "trucking_company": null,
  "truck_visit": null,
  "comment": null,
  "reschedule_reason": null,
  "cancelled_at": "2023-08-21T13:31:56.191+05:30",
  "cancelled_by": "System",
  "cancellation_reason": "Cancellation from client side",
  "purposes": []
}

Params

Param name Description
appointment_number
required

The appointment’s number

Validations:

  • Must be a String
cancellation_reason
required

The reason for cancelling the appointment

Validations:

  • Must be a String