Skip to main content
PUT
/
v1
/
campaign-creation
/
{interview_id}
/
finalize
Finalize Campaign
curl --request PUT \
  --url https://api.ontora.com/v1/campaign-creation/{interview_id}/finalize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "goal": "<string>",
  "interview_context_for_employee": "<string>",
  "success_criteria": "<string>",
  "agent_behavior": "<string>",
  "interview_type": "<string>",
  "voice_id": "<string>",
  "channel": "<string>",
  "welcome_screen": "<string>",
  "closing_message": "<string>",
  "recurring_interval": "<string>",
  "interview_duration_minutes": 123,
  "timeframe_start": "2023-11-07T05:31:56Z",
  "timeframe_end": "2023-11-07T05:31:56Z",
  "quick_mode_hours": 123,
  "scheduling_mode": "<string>",
  "start_immediately": true,
  "followup_enabled": true,
  "followup_strategy": "<string>",
  "followup_intervals_hours": [
    123
  ],
  "followup_deadline_days": [
    123
  ],
  "followup_message": "<string>",
  "topics": [],
  "questions": [],
  "contacts": []
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.ontora.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Path Parameters

interview_id
string<uuid>
required

Body

application/json

Full campaign save — persists all editor state atomically.

name
string | null
description
string | null
goal
string | null
interview_context_for_employee
string | null
success_criteria
string | null
agent_behavior
string | null
interview_type
string | null
voice_id
string | null
channel
string | null
welcome_screen
string | null
closing_message
string | null
recurring_interval
string | null
interview_duration_minutes
integer | null
timeframe_start
string<date-time> | null
timeframe_end
string<date-time> | null
quick_mode_hours
integer | null
scheduling_mode
string | null
start_immediately
boolean | null
followup_enabled
boolean | null
followup_strategy
string | null
followup_intervals_hours
integer[] | null
followup_deadline_days
integer[] | null
followup_message
string | null
topics
FinalizeTopicIn · object[]
questions
FinalizeQuestionIn · object[]
contacts
FinalizeContactIn · object[]

Response

Successful Response