interviewSchedule.update

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

Requires the interviewsWrite permission.

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

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

interviewEvent
required

An event on the interview schedule to create or update. To update an event, the event's interviewEventId must be included in the request.

The ids of interview events to cancel.

boolean
Defaults to false

By default, we do not allow interview events with submitted feedback to be canceled because canceling an event causes its associated feedback to be deleted. If you want to allow events with submitted feedback to be canceled, this flag can be passed in and set to true. In this case, events with feedback will be canceled, and any associated feedback will be deleted.

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json