interviews
Pause Interview
Pause an active interview.
post/v1/interviews/{interview_id}/pause
Path parameters
interview_idstring uuid required
Headers
X-API-Keystring nullable
Response
Successful Response
idstring uuid required
workspace_idstring uuid required
is_sharedboolean
shared_from_workspace_namestring nullable
share_scopestring
share_link_enabledboolean
join_link_deliveryboolean
namestring required
descriptionstring nullable required
goalstring nullable required
agent_behaviorstring nullable required
statusstring required
channelstring required
completion_thresholdinteger required
timeframe_startstring date-time nullable required
timeframe_endstring date-time nullable required
interview_orderstring required
interview_duration_minutesinteger required
timezonestring nullable
start_immediatelyboolean
scheduling_modestring
quick_mode_hoursinteger nullable
weekly_availabilityobject nullable
project_contextstring nullable
success_criteriastring nullable
interview_context_for_employeestring nullable
invitation_email_messagestring nullable
teams_invitation_messagestring nullable
agent_profile_idstring uuid nullable
agent_profile_snapshotobject nullable
interview_typestring nullable
default_languagestring nullable
voice_idstring nullable
voice_providerstring nullable
voice_languagestring nullable
voice_speednumber
participant_voice_selection_enabledboolean
participant_mode_selection_enabledboolean
participant_language_selection_enabledboolean
participant_selectable_languagesstring[]
participant_anonymity_selection_enabledboolean
participant_review_enabledboolean
result_summary_enabledboolean
result_summary_recipient_countinteger
welcome_screenstring nullable
closing_messagestring nullable
folderstring nullable
recurring_intervalstring nullable
followup_enabledboolean
followup_strategystring nullable
followup_intervals_hoursinteger[] nullable
followup_deadline_daysinteger[] nullable
followup_messagestring nullable
report_floor_countinteger nullable
incremental_update_every_ninteger nullable
use_agentic_synthesisboolean
is_anonymousboolean
anonymity_levelstring
contact_countinteger
completed_countinteger
scheduled_countinteger
created_bystring nullable required
created_by_emailstring nullable
created_by_namestring nullable
created_atstring date-time required
updated_atstring date-time required
Changes
No recorded changes to this endpoint across all 1 revision of this API.