Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Interview Schedule

interviewSchedule.cancel

Cancel an interview schedule by id.

Requires the interviewsWrite permission.

post/interviewSchedule.cancel

Request body

idstring uuid required

The id of the interview schedule to cancel

allowRescheduleboolean nullable

Whether or not this interview schedule can be rescheduled.

Example request

{
  "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the interviewSchedule.cancel endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "status": "Cancelled",
    "applicationId": "7211e226-7802-41fd-8d55-2720fe9d534f",
    "interviewStageId": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
    "scheduledBy": null,
    "createdAt": "2026-04-25T02:46:41.817Z",
    "updatedAt": "2026-04-25T02:46:46.230Z",
    "interviewEvents": []
  }
}