Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Interview Schedule

interviewSchedule.update

Update an interview schedule. This endpoint allows you to add, cancel, or update interview events associated with an interview schedule.

In order to update an interview event on a schedule, the event's interviewEventId must be included when sending your request. interviewEventIds are included in the response of the interviewSchedule.create endpoint.

Requires the interviewsWrite permission.

post/interviewSchedule.update

Request body

interviewScheduleIdstring uuid required

The id of the interview schedule to update. Only interview schedules created using the API key making the request can be updated.

allowFeedbackDeletionboolean nullable

By default, events with submitted feedback cannot be cancelled because cancellation deletes the associated feedback. Pass true to allow cancelling events with submitted feedback.

Example request

{
  "interviewScheduleId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "interviewEvent": {
    "startTime": "2023-01-30T15:00:00.000Z",
    "endTime": "2023-01-30T16:00:00.000Z",
    "interviewers": [
      {
        "email": "test@ashbyhq.com"
      }
    ],
    "extraData": {
      "partner_external_object_id": "12345",
      "partner_additional_data": "f763ba0e4"
    },
    "interviewId": "46648e83-f28f-43c4-a2a0-58e0599cff41"
  }
}

Response

Responses from the interviewSchedule.update 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": []
  }
}