Update Draft
curl --request PATCH \
--url https://api.ontora.com/v1/campaign-creation/{interview_id}/draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"goal": "<string>",
"project_context": "<string>",
"success_criteria": "<string>",
"interview_context_for_employee": "<string>",
"agent_behavior": "<string>",
"channel": "<string>",
"interview_duration_minutes": 123,
"interview_type": "<string>",
"voice_id": "<string>",
"welcome_screen": "<string>",
"closing_message": "<string>",
"recurring_interval": "<string>",
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"quick_mode_hours": 123,
"scheduling_mode": "<string>",
"start_immediately": true
}
'import requests
url = "https://api.ontora.com/v1/campaign-creation/{interview_id}/draft"
payload = {
"name": "<string>",
"description": "<string>",
"goal": "<string>",
"project_context": "<string>",
"success_criteria": "<string>",
"interview_context_for_employee": "<string>",
"agent_behavior": "<string>",
"channel": "<string>",
"interview_duration_minutes": 123,
"interview_type": "<string>",
"voice_id": "<string>",
"welcome_screen": "<string>",
"closing_message": "<string>",
"recurring_interval": "<string>",
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"quick_mode_hours": 123,
"scheduling_mode": "<string>",
"start_immediately": True
}
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>',
project_context: '<string>',
success_criteria: '<string>',
interview_context_for_employee: '<string>',
agent_behavior: '<string>',
channel: '<string>',
interview_duration_minutes: 123,
interview_type: '<string>',
voice_id: '<string>',
welcome_screen: '<string>',
closing_message: '<string>',
recurring_interval: '<string>',
timeframe_start: '2023-11-07T05:31:56Z',
timeframe_end: '2023-11-07T05:31:56Z',
quick_mode_hours: 123,
scheduling_mode: '<string>',
start_immediately: true
})
};
fetch('https://api.ontora.com/v1/campaign-creation/{interview_id}/draft', 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/campaign-creation/{interview_id}/draft",
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>',
'project_context' => '<string>',
'success_criteria' => '<string>',
'interview_context_for_employee' => '<string>',
'agent_behavior' => '<string>',
'channel' => '<string>',
'interview_duration_minutes' => 123,
'interview_type' => '<string>',
'voice_id' => '<string>',
'welcome_screen' => '<string>',
'closing_message' => '<string>',
'recurring_interval' => '<string>',
'timeframe_start' => '2023-11-07T05:31:56Z',
'timeframe_end' => '2023-11-07T05:31:56Z',
'quick_mode_hours' => 123,
'scheduling_mode' => '<string>',
'start_immediately' => true
]),
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/campaign-creation/{interview_id}/draft"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"project_context\": \"<string>\",\n \"success_criteria\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"<string>\",\n \"interview_duration_minutes\": 123,\n \"interview_type\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"recurring_interval\": \"<string>\",\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"quick_mode_hours\": 123,\n \"scheduling_mode\": \"<string>\",\n \"start_immediately\": true\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/campaign-creation/{interview_id}/draft")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"project_context\": \"<string>\",\n \"success_criteria\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"<string>\",\n \"interview_duration_minutes\": 123,\n \"interview_type\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"recurring_interval\": \"<string>\",\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"quick_mode_hours\": 123,\n \"scheduling_mode\": \"<string>\",\n \"start_immediately\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/campaign-creation/{interview_id}/draft")
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 \"project_context\": \"<string>\",\n \"success_criteria\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"<string>\",\n \"interview_duration_minutes\": 123,\n \"interview_type\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"recurring_interval\": \"<string>\",\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"quick_mode_hours\": 123,\n \"scheduling_mode\": \"<string>\",\n \"start_immediately\": true\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}campaign-creation
Update Draft
Manually update the draft interview configuration.
PATCH
/
v1
/
campaign-creation
/
{interview_id}
/
draft
Update Draft
curl --request PATCH \
--url https://api.ontora.com/v1/campaign-creation/{interview_id}/draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"goal": "<string>",
"project_context": "<string>",
"success_criteria": "<string>",
"interview_context_for_employee": "<string>",
"agent_behavior": "<string>",
"channel": "<string>",
"interview_duration_minutes": 123,
"interview_type": "<string>",
"voice_id": "<string>",
"welcome_screen": "<string>",
"closing_message": "<string>",
"recurring_interval": "<string>",
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"quick_mode_hours": 123,
"scheduling_mode": "<string>",
"start_immediately": true
}
'import requests
url = "https://api.ontora.com/v1/campaign-creation/{interview_id}/draft"
payload = {
"name": "<string>",
"description": "<string>",
"goal": "<string>",
"project_context": "<string>",
"success_criteria": "<string>",
"interview_context_for_employee": "<string>",
"agent_behavior": "<string>",
"channel": "<string>",
"interview_duration_minutes": 123,
"interview_type": "<string>",
"voice_id": "<string>",
"welcome_screen": "<string>",
"closing_message": "<string>",
"recurring_interval": "<string>",
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"quick_mode_hours": 123,
"scheduling_mode": "<string>",
"start_immediately": True
}
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>',
project_context: '<string>',
success_criteria: '<string>',
interview_context_for_employee: '<string>',
agent_behavior: '<string>',
channel: '<string>',
interview_duration_minutes: 123,
interview_type: '<string>',
voice_id: '<string>',
welcome_screen: '<string>',
closing_message: '<string>',
recurring_interval: '<string>',
timeframe_start: '2023-11-07T05:31:56Z',
timeframe_end: '2023-11-07T05:31:56Z',
quick_mode_hours: 123,
scheduling_mode: '<string>',
start_immediately: true
})
};
fetch('https://api.ontora.com/v1/campaign-creation/{interview_id}/draft', 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/campaign-creation/{interview_id}/draft",
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>',
'project_context' => '<string>',
'success_criteria' => '<string>',
'interview_context_for_employee' => '<string>',
'agent_behavior' => '<string>',
'channel' => '<string>',
'interview_duration_minutes' => 123,
'interview_type' => '<string>',
'voice_id' => '<string>',
'welcome_screen' => '<string>',
'closing_message' => '<string>',
'recurring_interval' => '<string>',
'timeframe_start' => '2023-11-07T05:31:56Z',
'timeframe_end' => '2023-11-07T05:31:56Z',
'quick_mode_hours' => 123,
'scheduling_mode' => '<string>',
'start_immediately' => true
]),
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/campaign-creation/{interview_id}/draft"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"project_context\": \"<string>\",\n \"success_criteria\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"<string>\",\n \"interview_duration_minutes\": 123,\n \"interview_type\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"recurring_interval\": \"<string>\",\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"quick_mode_hours\": 123,\n \"scheduling_mode\": \"<string>\",\n \"start_immediately\": true\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/campaign-creation/{interview_id}/draft")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"project_context\": \"<string>\",\n \"success_criteria\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"<string>\",\n \"interview_duration_minutes\": 123,\n \"interview_type\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"recurring_interval\": \"<string>\",\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"quick_mode_hours\": 123,\n \"scheduling_mode\": \"<string>\",\n \"start_immediately\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/campaign-creation/{interview_id}/draft")
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 \"project_context\": \"<string>\",\n \"success_criteria\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"<string>\",\n \"interview_duration_minutes\": 123,\n \"interview_type\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"recurring_interval\": \"<string>\",\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"quick_mode_hours\": 123,\n \"scheduling_mode\": \"<string>\",\n \"start_immediately\": true\n}"
response = http.request(request)
puts response.read_body{
"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.
Path Parameters
Body
application/json
Response
Successful Response
Was this page helpful?
⌘I