Update an interview

PATCH 
/v1/interviews/:id

Updates fields on an existing interview. Only provided fields are modified. organizer_id, application_id, job_id, candidate_id, and stage_activity_id are immutable. Calendar invites and notification emails are dispatched asynchronously. For externally-managed interviews Kula sends no invites/notifications; you can update external.video_conferencing_url, external.source, and external.event_id, but external.managed itself cannot be changed.

Request

Responses

200

Interview updated

404

Interview not found

422

Validation error. Common error codes:

• err_interview_cancelled — interview is already cancelled and cannot be edited
• err_start_time_not_aligned — same shape rule as create
• err_end_time_before_start_time / err_duration_out_of_range — end_time must be after start_time and yield a 5–1440 minute duration
• err_invalid_set_of_interviewers — merged-state kind/interviewer_ids mismatch
• err_onsite_office_required / err_zoom_host_id_required / err_zoom_host_id_not_in_interviewers / err_hackerrank_template_id_required — merged-state location/host requirements
• err_zoom_host_invalid_user — host_id user does not have an active Zoom workspace seat (validated when host_id or location changes)
• err_candidate_template_not_found / err_interviewer_template_not_found — template_id is unknown in your account
• err_candidate_template_invalid_category — candidate_template_id must have channel: calendar_invite and category: interview_coordination
• err_interviewer_template_invalid_category — interviewer_template_id must have channel: calendar_invite and category: interviewer_coordination
• err_office_not_found / err_interviewers_not_found — referenced resource missing
• err_invalid_iso_8601 / err_invalid_timezone — bad time/zone format
• err_start_time_less_than_current_time — model rejects past times on non-ended interviews