Update Interview
curl --request PATCH \
--url https://api.ontora.com/v1/interviews/{interview_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"goal": "<string>",
"agent_behavior": "<string>",
"channel": "<string>",
"completion_threshold": 123,
"status": "<string>",
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"interview_order": "<string>",
"interview_duration_minutes": 123,
"timezone": "<string>",
"start_immediately": true,
"scheduling_mode": "<string>",
"quick_mode_hours": 123,
"weekly_availability": {},
"project_context": "<string>",
"interview_context_for_employee": "<string>",
"invitation_email_message": "<string>",
"teams_invitation_message": "<string>",
"agent_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_profile_snapshot": {},
"interview_type": "<string>",
"default_language": "<string>",
"voice_id": "<string>",
"voice_provider": "<string>",
"voice_language": "<string>",
"voice_speed": 123,
"welcome_screen": "<string>",
"closing_message": "<string>",
"participant_voice_selection_enabled": true,
"participant_mode_selection_enabled": true,
"participant_language_selection_enabled": true,
"participant_anonymity_selection_enabled": true,
"participant_review_enabled": true,
"result_summary_enabled": true,
"folder": "<string>",
"recurring_interval": "<string>",
"followup_enabled": true,
"followup_strategy": "<string>",
"followup_intervals_hours": [
123
],
"followup_deadline_days": [
123
],
"followup_message": "<string>",
"report_floor_count": 123,
"incremental_update_every_n": 123,
"use_agentic_synthesis": true,
"is_anonymous": true,
"anonymity_level": "<string>"
}
'import requests
url = "https://api.ontora.com/v1/interviews/{interview_id}"
payload = {
"name": "<string>",
"description": "<string>",
"goal": "<string>",
"agent_behavior": "<string>",
"channel": "<string>",
"completion_threshold": 123,
"status": "<string>",
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"interview_order": "<string>",
"interview_duration_minutes": 123,
"timezone": "<string>",
"start_immediately": True,
"scheduling_mode": "<string>",
"quick_mode_hours": 123,
"weekly_availability": {},
"project_context": "<string>",
"interview_context_for_employee": "<string>",
"invitation_email_message": "<string>",
"teams_invitation_message": "<string>",
"agent_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_profile_snapshot": {},
"interview_type": "<string>",
"default_language": "<string>",
"voice_id": "<string>",
"voice_provider": "<string>",
"voice_language": "<string>",
"voice_speed": 123,
"welcome_screen": "<string>",
"closing_message": "<string>",
"participant_voice_selection_enabled": True,
"participant_mode_selection_enabled": True,
"participant_language_selection_enabled": True,
"participant_anonymity_selection_enabled": True,
"participant_review_enabled": True,
"result_summary_enabled": True,
"folder": "<string>",
"recurring_interval": "<string>",
"followup_enabled": True,
"followup_strategy": "<string>",
"followup_intervals_hours": [123],
"followup_deadline_days": [123],
"followup_message": "<string>",
"report_floor_count": 123,
"incremental_update_every_n": 123,
"use_agentic_synthesis": True,
"is_anonymous": True,
"anonymity_level": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
goal: '<string>',
agent_behavior: '<string>',
channel: '<string>',
completion_threshold: 123,
status: '<string>',
timeframe_start: '2023-11-07T05:31:56Z',
timeframe_end: '2023-11-07T05:31:56Z',
interview_order: '<string>',
interview_duration_minutes: 123,
timezone: '<string>',
start_immediately: true,
scheduling_mode: '<string>',
quick_mode_hours: 123,
weekly_availability: {},
project_context: '<string>',
interview_context_for_employee: '<string>',
invitation_email_message: '<string>',
teams_invitation_message: '<string>',
agent_profile_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
agent_profile_snapshot: {},
interview_type: '<string>',
default_language: '<string>',
voice_id: '<string>',
voice_provider: '<string>',
voice_language: '<string>',
voice_speed: 123,
welcome_screen: '<string>',
closing_message: '<string>',
participant_voice_selection_enabled: true,
participant_mode_selection_enabled: true,
participant_language_selection_enabled: true,
participant_anonymity_selection_enabled: true,
participant_review_enabled: true,
result_summary_enabled: true,
folder: '<string>',
recurring_interval: '<string>',
followup_enabled: true,
followup_strategy: '<string>',
followup_intervals_hours: [123],
followup_deadline_days: [123],
followup_message: '<string>',
report_floor_count: 123,
incremental_update_every_n: 123,
use_agentic_synthesis: true,
is_anonymous: true,
anonymity_level: '<string>'
})
};
fetch('https://api.ontora.com/v1/interviews/{interview_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ontora.com/v1/interviews/{interview_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'goal' => '<string>',
'agent_behavior' => '<string>',
'channel' => '<string>',
'completion_threshold' => 123,
'status' => '<string>',
'timeframe_start' => '2023-11-07T05:31:56Z',
'timeframe_end' => '2023-11-07T05:31:56Z',
'interview_order' => '<string>',
'interview_duration_minutes' => 123,
'timezone' => '<string>',
'start_immediately' => true,
'scheduling_mode' => '<string>',
'quick_mode_hours' => 123,
'weekly_availability' => [
],
'project_context' => '<string>',
'interview_context_for_employee' => '<string>',
'invitation_email_message' => '<string>',
'teams_invitation_message' => '<string>',
'agent_profile_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'agent_profile_snapshot' => [
],
'interview_type' => '<string>',
'default_language' => '<string>',
'voice_id' => '<string>',
'voice_provider' => '<string>',
'voice_language' => '<string>',
'voice_speed' => 123,
'welcome_screen' => '<string>',
'closing_message' => '<string>',
'participant_voice_selection_enabled' => true,
'participant_mode_selection_enabled' => true,
'participant_language_selection_enabled' => true,
'participant_anonymity_selection_enabled' => true,
'participant_review_enabled' => true,
'result_summary_enabled' => true,
'folder' => '<string>',
'recurring_interval' => '<string>',
'followup_enabled' => true,
'followup_strategy' => '<string>',
'followup_intervals_hours' => [
123
],
'followup_deadline_days' => [
123
],
'followup_message' => '<string>',
'report_floor_count' => 123,
'incremental_update_every_n' => 123,
'use_agentic_synthesis' => true,
'is_anonymous' => true,
'anonymity_level' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ontora.com/v1/interviews/{interview_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"<string>\",\n \"completion_threshold\": 123,\n \"status\": \"<string>\",\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"interview_order\": \"<string>\",\n \"interview_duration_minutes\": 123,\n \"timezone\": \"<string>\",\n \"start_immediately\": true,\n \"scheduling_mode\": \"<string>\",\n \"quick_mode_hours\": 123,\n \"weekly_availability\": {},\n \"project_context\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"invitation_email_message\": \"<string>\",\n \"teams_invitation_message\": \"<string>\",\n \"agent_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent_profile_snapshot\": {},\n \"interview_type\": \"<string>\",\n \"default_language\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"voice_provider\": \"<string>\",\n \"voice_language\": \"<string>\",\n \"voice_speed\": 123,\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"participant_voice_selection_enabled\": true,\n \"participant_mode_selection_enabled\": true,\n \"participant_language_selection_enabled\": true,\n \"participant_anonymity_selection_enabled\": true,\n \"participant_review_enabled\": true,\n \"result_summary_enabled\": true,\n \"folder\": \"<string>\",\n \"recurring_interval\": \"<string>\",\n \"followup_enabled\": true,\n \"followup_strategy\": \"<string>\",\n \"followup_intervals_hours\": [\n 123\n ],\n \"followup_deadline_days\": [\n 123\n ],\n \"followup_message\": \"<string>\",\n \"report_floor_count\": 123,\n \"incremental_update_every_n\": 123,\n \"use_agentic_synthesis\": true,\n \"is_anonymous\": true,\n \"anonymity_level\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.ontora.com/v1/interviews/{interview_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"<string>\",\n \"completion_threshold\": 123,\n \"status\": \"<string>\",\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"interview_order\": \"<string>\",\n \"interview_duration_minutes\": 123,\n \"timezone\": \"<string>\",\n \"start_immediately\": true,\n \"scheduling_mode\": \"<string>\",\n \"quick_mode_hours\": 123,\n \"weekly_availability\": {},\n \"project_context\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"invitation_email_message\": \"<string>\",\n \"teams_invitation_message\": \"<string>\",\n \"agent_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent_profile_snapshot\": {},\n \"interview_type\": \"<string>\",\n \"default_language\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"voice_provider\": \"<string>\",\n \"voice_language\": \"<string>\",\n \"voice_speed\": 123,\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"participant_voice_selection_enabled\": true,\n \"participant_mode_selection_enabled\": true,\n \"participant_language_selection_enabled\": true,\n \"participant_anonymity_selection_enabled\": true,\n \"participant_review_enabled\": true,\n \"result_summary_enabled\": true,\n \"folder\": \"<string>\",\n \"recurring_interval\": \"<string>\",\n \"followup_enabled\": true,\n \"followup_strategy\": \"<string>\",\n \"followup_intervals_hours\": [\n 123\n ],\n \"followup_deadline_days\": [\n 123\n ],\n \"followup_message\": \"<string>\",\n \"report_floor_count\": 123,\n \"incremental_update_every_n\": 123,\n \"use_agentic_synthesis\": true,\n \"is_anonymous\": true,\n \"anonymity_level\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/interviews/{interview_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"<string>\",\n \"completion_threshold\": 123,\n \"status\": \"<string>\",\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"interview_order\": \"<string>\",\n \"interview_duration_minutes\": 123,\n \"timezone\": \"<string>\",\n \"start_immediately\": true,\n \"scheduling_mode\": \"<string>\",\n \"quick_mode_hours\": 123,\n \"weekly_availability\": {},\n \"project_context\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"invitation_email_message\": \"<string>\",\n \"teams_invitation_message\": \"<string>\",\n \"agent_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent_profile_snapshot\": {},\n \"interview_type\": \"<string>\",\n \"default_language\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"voice_provider\": \"<string>\",\n \"voice_language\": \"<string>\",\n \"voice_speed\": 123,\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"participant_voice_selection_enabled\": true,\n \"participant_mode_selection_enabled\": true,\n \"participant_language_selection_enabled\": true,\n \"participant_anonymity_selection_enabled\": true,\n \"participant_review_enabled\": true,\n \"result_summary_enabled\": true,\n \"folder\": \"<string>\",\n \"recurring_interval\": \"<string>\",\n \"followup_enabled\": true,\n \"followup_strategy\": \"<string>\",\n \"followup_intervals_hours\": [\n 123\n ],\n \"followup_deadline_days\": [\n 123\n ],\n \"followup_message\": \"<string>\",\n \"report_floor_count\": 123,\n \"incremental_update_every_n\": 123,\n \"use_agentic_synthesis\": true,\n \"is_anonymous\": true,\n \"anonymity_level\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"goal": "<string>",
"agent_behavior": "<string>",
"status": "<string>",
"channel": "<string>",
"completion_threshold": 123,
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"interview_order": "<string>",
"interview_duration_minutes": 123,
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_shared": false,
"shared_from_workspace_name": "<string>",
"share_scope": "restricted",
"share_link_enabled": false,
"join_link_delivery": false,
"timezone": "<string>",
"start_immediately": true,
"scheduling_mode": "availability",
"quick_mode_hours": 123,
"weekly_availability": {},
"project_context": "<string>",
"success_criteria": "<string>",
"interview_context_for_employee": "<string>",
"invitation_email_message": "<string>",
"teams_invitation_message": "<string>",
"agent_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_profile_snapshot": {},
"draft_guide": [
"<unknown>"
],
"interview_type": "<string>",
"default_language": "<string>",
"voice_id": "<string>",
"voice_provider": "<string>",
"voice_language": "<string>",
"voice_speed": 1,
"participant_voice_selection_enabled": false,
"participant_mode_selection_enabled": false,
"participant_language_selection_enabled": false,
"participant_anonymity_selection_enabled": false,
"participant_review_enabled": false,
"result_summary_enabled": false,
"result_summary_recipient_count": 0,
"welcome_screen": "<string>",
"closing_message": "<string>",
"folder": "<string>",
"recurring_interval": "<string>",
"followup_enabled": false,
"followup_strategy": "<string>",
"followup_intervals_hours": [
123
],
"followup_deadline_days": [
123
],
"followup_message": "<string>",
"report_floor_count": 123,
"incremental_update_every_n": 123,
"use_agentic_synthesis": false,
"is_anonymous": false,
"anonymity_level": "none",
"contact_count": 0,
"completed_count": 0,
"scheduled_count": 0,
"created_by_email": "<string>",
"created_by_name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}interviews
Update Interview
PATCH
/
v1
/
interviews
/
{interview_id}
Update Interview
curl --request PATCH \
--url https://api.ontora.com/v1/interviews/{interview_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"goal": "<string>",
"agent_behavior": "<string>",
"channel": "<string>",
"completion_threshold": 123,
"status": "<string>",
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"interview_order": "<string>",
"interview_duration_minutes": 123,
"timezone": "<string>",
"start_immediately": true,
"scheduling_mode": "<string>",
"quick_mode_hours": 123,
"weekly_availability": {},
"project_context": "<string>",
"interview_context_for_employee": "<string>",
"invitation_email_message": "<string>",
"teams_invitation_message": "<string>",
"agent_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_profile_snapshot": {},
"interview_type": "<string>",
"default_language": "<string>",
"voice_id": "<string>",
"voice_provider": "<string>",
"voice_language": "<string>",
"voice_speed": 123,
"welcome_screen": "<string>",
"closing_message": "<string>",
"participant_voice_selection_enabled": true,
"participant_mode_selection_enabled": true,
"participant_language_selection_enabled": true,
"participant_anonymity_selection_enabled": true,
"participant_review_enabled": true,
"result_summary_enabled": true,
"folder": "<string>",
"recurring_interval": "<string>",
"followup_enabled": true,
"followup_strategy": "<string>",
"followup_intervals_hours": [
123
],
"followup_deadline_days": [
123
],
"followup_message": "<string>",
"report_floor_count": 123,
"incremental_update_every_n": 123,
"use_agentic_synthesis": true,
"is_anonymous": true,
"anonymity_level": "<string>"
}
'import requests
url = "https://api.ontora.com/v1/interviews/{interview_id}"
payload = {
"name": "<string>",
"description": "<string>",
"goal": "<string>",
"agent_behavior": "<string>",
"channel": "<string>",
"completion_threshold": 123,
"status": "<string>",
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"interview_order": "<string>",
"interview_duration_minutes": 123,
"timezone": "<string>",
"start_immediately": True,
"scheduling_mode": "<string>",
"quick_mode_hours": 123,
"weekly_availability": {},
"project_context": "<string>",
"interview_context_for_employee": "<string>",
"invitation_email_message": "<string>",
"teams_invitation_message": "<string>",
"agent_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_profile_snapshot": {},
"interview_type": "<string>",
"default_language": "<string>",
"voice_id": "<string>",
"voice_provider": "<string>",
"voice_language": "<string>",
"voice_speed": 123,
"welcome_screen": "<string>",
"closing_message": "<string>",
"participant_voice_selection_enabled": True,
"participant_mode_selection_enabled": True,
"participant_language_selection_enabled": True,
"participant_anonymity_selection_enabled": True,
"participant_review_enabled": True,
"result_summary_enabled": True,
"folder": "<string>",
"recurring_interval": "<string>",
"followup_enabled": True,
"followup_strategy": "<string>",
"followup_intervals_hours": [123],
"followup_deadline_days": [123],
"followup_message": "<string>",
"report_floor_count": 123,
"incremental_update_every_n": 123,
"use_agentic_synthesis": True,
"is_anonymous": True,
"anonymity_level": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
goal: '<string>',
agent_behavior: '<string>',
channel: '<string>',
completion_threshold: 123,
status: '<string>',
timeframe_start: '2023-11-07T05:31:56Z',
timeframe_end: '2023-11-07T05:31:56Z',
interview_order: '<string>',
interview_duration_minutes: 123,
timezone: '<string>',
start_immediately: true,
scheduling_mode: '<string>',
quick_mode_hours: 123,
weekly_availability: {},
project_context: '<string>',
interview_context_for_employee: '<string>',
invitation_email_message: '<string>',
teams_invitation_message: '<string>',
agent_profile_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
agent_profile_snapshot: {},
interview_type: '<string>',
default_language: '<string>',
voice_id: '<string>',
voice_provider: '<string>',
voice_language: '<string>',
voice_speed: 123,
welcome_screen: '<string>',
closing_message: '<string>',
participant_voice_selection_enabled: true,
participant_mode_selection_enabled: true,
participant_language_selection_enabled: true,
participant_anonymity_selection_enabled: true,
participant_review_enabled: true,
result_summary_enabled: true,
folder: '<string>',
recurring_interval: '<string>',
followup_enabled: true,
followup_strategy: '<string>',
followup_intervals_hours: [123],
followup_deadline_days: [123],
followup_message: '<string>',
report_floor_count: 123,
incremental_update_every_n: 123,
use_agentic_synthesis: true,
is_anonymous: true,
anonymity_level: '<string>'
})
};
fetch('https://api.ontora.com/v1/interviews/{interview_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ontora.com/v1/interviews/{interview_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'goal' => '<string>',
'agent_behavior' => '<string>',
'channel' => '<string>',
'completion_threshold' => 123,
'status' => '<string>',
'timeframe_start' => '2023-11-07T05:31:56Z',
'timeframe_end' => '2023-11-07T05:31:56Z',
'interview_order' => '<string>',
'interview_duration_minutes' => 123,
'timezone' => '<string>',
'start_immediately' => true,
'scheduling_mode' => '<string>',
'quick_mode_hours' => 123,
'weekly_availability' => [
],
'project_context' => '<string>',
'interview_context_for_employee' => '<string>',
'invitation_email_message' => '<string>',
'teams_invitation_message' => '<string>',
'agent_profile_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'agent_profile_snapshot' => [
],
'interview_type' => '<string>',
'default_language' => '<string>',
'voice_id' => '<string>',
'voice_provider' => '<string>',
'voice_language' => '<string>',
'voice_speed' => 123,
'welcome_screen' => '<string>',
'closing_message' => '<string>',
'participant_voice_selection_enabled' => true,
'participant_mode_selection_enabled' => true,
'participant_language_selection_enabled' => true,
'participant_anonymity_selection_enabled' => true,
'participant_review_enabled' => true,
'result_summary_enabled' => true,
'folder' => '<string>',
'recurring_interval' => '<string>',
'followup_enabled' => true,
'followup_strategy' => '<string>',
'followup_intervals_hours' => [
123
],
'followup_deadline_days' => [
123
],
'followup_message' => '<string>',
'report_floor_count' => 123,
'incremental_update_every_n' => 123,
'use_agentic_synthesis' => true,
'is_anonymous' => true,
'anonymity_level' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ontora.com/v1/interviews/{interview_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"<string>\",\n \"completion_threshold\": 123,\n \"status\": \"<string>\",\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"interview_order\": \"<string>\",\n \"interview_duration_minutes\": 123,\n \"timezone\": \"<string>\",\n \"start_immediately\": true,\n \"scheduling_mode\": \"<string>\",\n \"quick_mode_hours\": 123,\n \"weekly_availability\": {},\n \"project_context\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"invitation_email_message\": \"<string>\",\n \"teams_invitation_message\": \"<string>\",\n \"agent_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent_profile_snapshot\": {},\n \"interview_type\": \"<string>\",\n \"default_language\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"voice_provider\": \"<string>\",\n \"voice_language\": \"<string>\",\n \"voice_speed\": 123,\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"participant_voice_selection_enabled\": true,\n \"participant_mode_selection_enabled\": true,\n \"participant_language_selection_enabled\": true,\n \"participant_anonymity_selection_enabled\": true,\n \"participant_review_enabled\": true,\n \"result_summary_enabled\": true,\n \"folder\": \"<string>\",\n \"recurring_interval\": \"<string>\",\n \"followup_enabled\": true,\n \"followup_strategy\": \"<string>\",\n \"followup_intervals_hours\": [\n 123\n ],\n \"followup_deadline_days\": [\n 123\n ],\n \"followup_message\": \"<string>\",\n \"report_floor_count\": 123,\n \"incremental_update_every_n\": 123,\n \"use_agentic_synthesis\": true,\n \"is_anonymous\": true,\n \"anonymity_level\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.ontora.com/v1/interviews/{interview_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"<string>\",\n \"completion_threshold\": 123,\n \"status\": \"<string>\",\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"interview_order\": \"<string>\",\n \"interview_duration_minutes\": 123,\n \"timezone\": \"<string>\",\n \"start_immediately\": true,\n \"scheduling_mode\": \"<string>\",\n \"quick_mode_hours\": 123,\n \"weekly_availability\": {},\n \"project_context\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"invitation_email_message\": \"<string>\",\n \"teams_invitation_message\": \"<string>\",\n \"agent_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent_profile_snapshot\": {},\n \"interview_type\": \"<string>\",\n \"default_language\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"voice_provider\": \"<string>\",\n \"voice_language\": \"<string>\",\n \"voice_speed\": 123,\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"participant_voice_selection_enabled\": true,\n \"participant_mode_selection_enabled\": true,\n \"participant_language_selection_enabled\": true,\n \"participant_anonymity_selection_enabled\": true,\n \"participant_review_enabled\": true,\n \"result_summary_enabled\": true,\n \"folder\": \"<string>\",\n \"recurring_interval\": \"<string>\",\n \"followup_enabled\": true,\n \"followup_strategy\": \"<string>\",\n \"followup_intervals_hours\": [\n 123\n ],\n \"followup_deadline_days\": [\n 123\n ],\n \"followup_message\": \"<string>\",\n \"report_floor_count\": 123,\n \"incremental_update_every_n\": 123,\n \"use_agentic_synthesis\": true,\n \"is_anonymous\": true,\n \"anonymity_level\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/interviews/{interview_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"<string>\",\n \"completion_threshold\": 123,\n \"status\": \"<string>\",\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"interview_order\": \"<string>\",\n \"interview_duration_minutes\": 123,\n \"timezone\": \"<string>\",\n \"start_immediately\": true,\n \"scheduling_mode\": \"<string>\",\n \"quick_mode_hours\": 123,\n \"weekly_availability\": {},\n \"project_context\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"invitation_email_message\": \"<string>\",\n \"teams_invitation_message\": \"<string>\",\n \"agent_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent_profile_snapshot\": {},\n \"interview_type\": \"<string>\",\n \"default_language\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"voice_provider\": \"<string>\",\n \"voice_language\": \"<string>\",\n \"voice_speed\": 123,\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"participant_voice_selection_enabled\": true,\n \"participant_mode_selection_enabled\": true,\n \"participant_language_selection_enabled\": true,\n \"participant_anonymity_selection_enabled\": true,\n \"participant_review_enabled\": true,\n \"result_summary_enabled\": true,\n \"folder\": \"<string>\",\n \"recurring_interval\": \"<string>\",\n \"followup_enabled\": true,\n \"followup_strategy\": \"<string>\",\n \"followup_intervals_hours\": [\n 123\n ],\n \"followup_deadline_days\": [\n 123\n ],\n \"followup_message\": \"<string>\",\n \"report_floor_count\": 123,\n \"incremental_update_every_n\": 123,\n \"use_agentic_synthesis\": true,\n \"is_anonymous\": true,\n \"anonymity_level\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"goal": "<string>",
"agent_behavior": "<string>",
"status": "<string>",
"channel": "<string>",
"completion_threshold": 123,
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"interview_order": "<string>",
"interview_duration_minutes": 123,
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_shared": false,
"shared_from_workspace_name": "<string>",
"share_scope": "restricted",
"share_link_enabled": false,
"join_link_delivery": false,
"timezone": "<string>",
"start_immediately": true,
"scheduling_mode": "availability",
"quick_mode_hours": 123,
"weekly_availability": {},
"project_context": "<string>",
"success_criteria": "<string>",
"interview_context_for_employee": "<string>",
"invitation_email_message": "<string>",
"teams_invitation_message": "<string>",
"agent_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_profile_snapshot": {},
"draft_guide": [
"<unknown>"
],
"interview_type": "<string>",
"default_language": "<string>",
"voice_id": "<string>",
"voice_provider": "<string>",
"voice_language": "<string>",
"voice_speed": 1,
"participant_voice_selection_enabled": false,
"participant_mode_selection_enabled": false,
"participant_language_selection_enabled": false,
"participant_anonymity_selection_enabled": false,
"participant_review_enabled": false,
"result_summary_enabled": false,
"result_summary_recipient_count": 0,
"welcome_screen": "<string>",
"closing_message": "<string>",
"folder": "<string>",
"recurring_interval": "<string>",
"followup_enabled": false,
"followup_strategy": "<string>",
"followup_intervals_hours": [
123
],
"followup_deadline_days": [
123
],
"followup_message": "<string>",
"report_floor_count": 123,
"incremental_update_every_n": 123,
"use_agentic_synthesis": false,
"is_anonymous": false,
"anonymity_level": "none",
"contact_count": 0,
"completed_count": 0,
"scheduled_count": 0,
"created_by_email": "<string>",
"created_by_name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Path Parameters
Body
application/json
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.
Maximum string length:
4000Maximum string length:
4000Response
Successful Response
Was this page helpful?