Skip to main content
PATCH
Update Interview

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

interview_id
string<uuid>
required

Body

application/json
name
string | null
description
string | null
goal
string | null
agent_behavior
string | null
channel
string | null
completion_threshold
integer | null
status
string | null
timeframe_start
string<date-time> | null
timeframe_end
string<date-time> | null
interview_order
string | null
interview_duration_minutes
integer | null

Interview length in minutes. Must be one of 5, 10, 15, 20, 30, or 45; other values are snapped to the nearest allowed one (ties favor the shorter), and 0 maps to the default of 30.

timezone
string | null
start_immediately
boolean | null
scheduling_mode
string | null
quick_mode_hours
integer | null
weekly_availability
Weekly Availability · object | null
project_context
string | null
interview_context_for_employee
string | null
invitation_email_message
string | null
Maximum string length: 4000
teams_invitation_message
string | null
Maximum string length: 4000
agent_profile_id
string<uuid> | null
agent_profile_snapshot
Agent Profile Snapshot · object | null
interview_type
string | null
default_language
string | null
voice_id
string | null
voice_provider
string | null
voice_language
string | null
voice_speed
number | null
welcome_screen
string | null
closing_message
string | null
participant_voice_selection_enabled
boolean | null
participant_mode_selection_enabled
boolean | null
participant_language_selection_enabled
boolean | null
participant_anonymity_selection_enabled
boolean | null
participant_review_enabled
boolean | null
result_summary_enabled
boolean | null
folder
string | null
recurring_interval
string | null
followup_enabled
boolean | null
followup_strategy
string | null
followup_intervals_hours
integer[] | null
followup_deadline_days
integer[] | null
followup_message
string | null
report_floor_count
integer | null
incremental_update_every_n
integer | null
use_agentic_synthesis
boolean | null
is_anonymous
boolean | null
anonymity_level
string | null

Response

Successful Response

id
string<uuid>
required
workspace_id
string<uuid>
required
name
string
required
description
string | null
required
goal
string | null
required
agent_behavior
string | null
required
status
string
required
channel
string
required
completion_threshold
integer
required
timeframe_start
string<date-time> | null
required
timeframe_end
string<date-time> | null
required
interview_order
string
required
interview_duration_minutes
integer
required
created_by
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
is_shared
boolean
default:false
shared_from_workspace_name
string | null
share_scope
string
default:restricted
timezone
string | null
start_immediately
boolean
default:true
scheduling_mode
string
default:availability
quick_mode_hours
integer | null
weekly_availability
Weekly Availability · object | null
project_context
string | null
success_criteria
string | null
interview_context_for_employee
string | null
invitation_email_message
string | null
teams_invitation_message
string | null
agent_profile_id
string<uuid> | null
agent_profile_snapshot
Agent Profile Snapshot · object | null
draft_guide
any[] | null
interview_type
string | null
default_language
string | null
voice_id
string | null
voice_provider
string | null
voice_language
string | null
voice_speed
number
default:1
participant_voice_selection_enabled
boolean
default:false
participant_mode_selection_enabled
boolean
default:false
participant_language_selection_enabled
boolean
default:false
participant_anonymity_selection_enabled
boolean
default:false
participant_review_enabled
boolean
default:false
result_summary_enabled
boolean
default:false
result_summary_recipient_count
integer
default:0
welcome_screen
string | null
closing_message
string | null
folder
string | null
recurring_interval
string | null
followup_enabled
boolean
default:false
followup_strategy
string | null
followup_intervals_hours
integer[] | null
followup_deadline_days
integer[] | null
followup_message
string | null
report_floor_count
integer | null
incremental_update_every_n
integer | null
use_agentic_synthesis
boolean
default:false
is_anonymous
boolean
default:false
anonymity_level
string
default:none
contact_count
integer
default:0
completed_count
integer
default:0
scheduled_count
integer
default:0
created_by_email
string | null
created_by_name
string | null