Interviews

Update Interview

Update interview

Validates that interview belongs to current user's organization Requires: admin or recruiter role

put/api/interviews/{interview_id}

Request

Base URL: https://api.thebetterhire.ai (the document declares no server; this is the origin it was published from)
URL: https://api.thebetterhire.ai/api/interviews/{interview_id}
Auth: HTTP bearer

Path parameters

interview_idstring uuid required

Request body

candidate_namestring nullable

candidate_emailstring email nullable

candidate_phonestring nullable

rolestring nullable

job_role_idstring uuid nullable

scheduled_atstring date-time nullable

duration_minutesinteger nullable

meeting_urlstring nullable

interview_typestring nullable

notesstring nullable

statusstring nullable

Response

Successful Response

idstring required

organization_idstring required

candidate_idstring nullable

candidate_namestring required

candidate_emailstring nullable

candidate_phonestring nullable

candidate_refstring nullable

rolestring required

job_role_idstring nullable required

interviewer_idstring nullable required

scheduled_atstring date-time nullable required

scheduled_timezonestring nullable

duration_minutesinteger required

meeting_urlstring nullable required

interviewer_emailstring nullable

meeting_link_statusstring nullable

failure_reasonstring nullable

calendar_healthobject nullable

interview_typestring nullable required

interview_stage_idstring nullable

stage_orderinteger nullable

stage_namestring nullable

statusstring required

scoreinteger nullable

recommendationstring nullable

is_test_modeboolean

audio_urlstring nullable required

audio_s3_keystring nullable

audio_sourcestring nullable

audio_size_bytesinteger nullable required

audio_duration_secondsinteger nullable required

transcript_statusstring nullable

analysis_statusstring nullable

analysis_resultsobject nullable

recruiter_analysisobject nullable

candidate_analysisobject nullable

generated_report_typesstring[] nullable

notesstring nullable required

actual_start_timestring date-time nullable required

actual_end_timestring date-time nullable required

started_atstring date-time nullable

ended_atstring date-time nullable

created_atstring date-time required

updated_atstring date-time nullable required

created_bystring nullable required

delivery_modestring nullable

voice_call_idstring nullable

voice_call_statusstring nullable

voice_providerstring nullable

call_recording_urlstring nullable

screening_scoreinteger nullable

screening_recommendationstring nullable

screening_analysisobject nullable

screening_question_idsstring[] nullable

join_tokenstring nullable

meeting_join_tokenstring nullable

interviewer_typestring nullable

brain_analysisobject nullable

excludedboolean

excluded_reasonstring nullable

excluded_notesstring nullable

excluded_atstring date-time nullable

excluded_bystring nullable

plan_roundobject nullable

skill_idstring nullable

speaker_roles_needs_confirmationboolean

speaker_roles_resolutionstring nullable

speaker_roles_confirmed_atstring date-time nullable

speaker_roles_confirmed_bystring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.