API Reference

Campaigns

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update a campaign

campaigns.update(strid, CampaignUpdateParams**kwargs) -> CampaignUpdateResponse

PATCH/campaigns/{id}

Update editable fields on a campaign. Draft campaigns support updating all fields including assistant, contacts, and settings. Non-draft campaigns only support renaming.

ParametersExpand Collapse

id: str

assistant_id: Optional[str]

The ID of the assistant to use (draft only)

formatuuid

call_retry_config: Optional[CallRetryConfig]

Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

allowed_days: List[Literal["monday", "tuesday", "wednesday", 4 more]]

Days of the week when calls are allowed, in the recipient's timezone. Default: Monday through Friday.

One of the following:

"monday"

"tuesday"

"wednesday"

"thursday"

"friday"

"saturday"

"sunday"

call_twice_in_a_row: bool

If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retry_delay_seconds) when attempt #1 didn't reach a human. Calling-window/allowed-days checks still apply. Only affects the 1→2 transition. Default: false.

calling_windows: Iterable[CallRetryConfigCallingWindow]

calling_window_end_time: str

End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

calling_window_start_time: str

Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

retry_delay_seconds: int

Delay between retry attempts in seconds. 0 retries as soon as the calling window allows. Default: 7200 (2 hours).

minimum0

maximum9007199254740991

max_retry_attempts: int

Maximum number of call retry attempts. Default: 3.

exclusiveMinimum0

maximum9007199254740991

timezone: Optional[str]

Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

contacts: Optional[Iterable[Contact]]

Replace contact list (draft only)

prompt_variables: Dict[str, str]

to_phone_number: str

from_phone_number: Optional[str]

The phone number to use for outbound calls (draft only)

max_concurrent_calls: Optional[float]

Maximum concurrent calls (draft only)

minimum1

name: Optional[str]

Campaign display name

minLength1

maxLength255

scheduled_at: Optional[Union[Union[str, datetime], object, null]]

Scheduled start time (draft only)

One of the following:

Union[str, datetime]

object

type: Optional[Literal["regular", "jump_in"]]

Campaign type (draft only)

One of the following:

"regular"

"jump_in"

ReturnsExpand Collapse

class CampaignUpdateResponse: …

campaign: Campaign

id: str

assistant_id: str

created_at: object

is_cancelled: bool

name: str

organization_id: str

status: Literal["draft", "running", "paused", "completed"]

One of the following:

"draft"

"running"

"paused"

"completed"

type: Literal["regular", "jump_in"]

One of the following:

"regular"

"jump_in"

updated_at: object

active_takeover_call_id: Optional[str]

assistant: Optional[CampaignAssistant]

id: str

after_call_sms_outcomes: Optional[List[Literal["not_interested", "interested", "completed", 2 more]]]

Which call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use "none" when outcome is null.

One of the following:

"not_interested"

"interested"

"completed"

"requested_callback_later"

"none"

after_call_sms_prompt: Optional[str]

Prompt / instructions for the after-call SMS. Supports {{variable}} placeholders. When null, no after-call SMS is sent.

background_sound: Optional[Literal["audio/office.ogg"]]

Ambient background sound to play during the call. null disables it.

background_sound_volume: float

Volume of the ambient background sound (0 = silent, 1 = max).

minimum0

maximum1

calendly: Optional[CampaignAssistantCalendly]

connection_id: str

The connection ID representing the link between your Calendly account and Revox.

event_type_id: str

The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

call_retry_config: Optional[CampaignAssistantCallRetryConfig]

Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

allowed_days: List[Literal["monday", "tuesday", "wednesday", 4 more]]

Days of the week when calls are allowed, in the recipient's timezone. Default: Monday through Friday.

One of the following:

"monday"

"tuesday"

"wednesday"

"thursday"

"friday"

"saturday"

"sunday"

call_twice_in_a_row: bool

If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retry_delay_seconds) when attempt #1 didn't reach a human. Calling-window/allowed-days checks still apply. Only affects the 1→2 transition. Default: false.

calling_windows: List[CampaignAssistantCallRetryConfigCallingWindow]

calling_window_end_time: str

End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

calling_window_start_time: str

Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

retry_delay_seconds: int

Delay between retry attempts in seconds. 0 retries as soon as the calling window allows. Default: 7200 (2 hours).

minimum0

maximum9007199254740991

max_retry_attempts: int

Maximum number of call retry attempts. Default: 3.

exclusiveMinimum0

maximum9007199254740991

timezone: Optional[str]

Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

cartesia_dictionary_pronunciation_id: Optional[str]

Optional Cartesia pronunciation dictionary ID linked to this assistant.

created_at: object

custom_tools: Optional[List[CampaignAssistantCustomTool]]

body_template: Optional[str]

JSON body template for the request. Use quoted {{variable}} placeholders (e.g. "{{name}}") for dynamic values

description: str

Human-readable description of what the tool does, used by the LLM to decide when to call it

minLength1

headers: List[CampaignAssistantCustomToolHeader]

HTTP headers to include in the request. Values support {{variable}} placeholders

key: str

minLength1

value: str

input_schema: List[CampaignAssistantCustomToolInputSchema]

Schema defining the parameters the LLM should extract from the conversation to pass to this tool

name: str

minLength1

required: bool

type: Literal["string", "number", "boolean", 3 more]

One of the following:

"string"

"number"

"boolean"

"enum"

"date"

"datetime"

description: Optional[str]

enum_options: Optional[List[str]]

method: Literal["GET", "POST", "PUT", 2 more]

HTTP method to use when calling the API endpoint

One of the following:

"GET"

"POST"

"PUT"

"PATCH"

"DELETE"

name: str

Unique tool name in lowercase_snake_case (e.g. check_inventory)

minLength1

query_params: List[CampaignAssistantCustomToolQueryParam]

Query string parameters appended to the URL. Values support {{variable}} placeholders

key: str

minLength1

value: str

url: str

Full URL of the API endpoint. Supports {{variable}} placeholders for dynamic values

minLength1

email_notification_address: Optional[str]

Email address(es) to receive notifications when a call ends with a matching outcome. Accepts a single email or a comma-separated list (e.g. "alice@x.com, bob@y.com").

email_notification_outcomes: Optional[List[Literal["not_interested", "interested", "completed", 2 more]]]

Which call outcomes trigger an email notification. E.g. ["interested", "completed", "none"]. Use "none" when outcome is null.

One of the following:

"not_interested"

"interested"

"completed"

"requested_callback_later"

"none"

end_of_call_sentence: Optional[str]

first_sentence: Optional[str]

first_sentence_delay_ms: int

Delay in milliseconds before speaking the first sentence. Default: 400.

minimum-9007199254740991

maximum9007199254740991

first_sentence_mode: Literal["generated", "static", "none"]

One of the following:

"generated"

"static"

"none"

from_phone_number: Optional[str]

Override the default outbound phone number for calls placed with this assistant. When null, the organization's default phone number is used.

human_transfer_mode: Optional[Literal["warm", "cold"]]

Warm or cold transfer when transfer_phone_number is set; null when transfer is not configured.

One of the following:

"warm"

"cold"

ivr_navigation_enabled: bool

Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.

llm_model: CampaignAssistantLlmModel

One of the following:

class CampaignAssistantLlmModelUnionMember0: …

name: Literal["gpt-4.1", "ministral-3-8b-instruct"]

One of the following:

"gpt-4.1"

"ministral-3-8b-instruct"

type: Literal["dedicated-instance"]

class CampaignAssistantLlmModelUnionMember1: …

openrouter_model_id: str

The model ID to use from OpenRouter. eg: openai/gpt-4.1

openrouter_provider: str

The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

type: Literal["openrouter"]

Use a model from OpenRouter.

class CampaignAssistantLlmModelUnionMember2: …

api_key: str

API key sent as Bearer token to the custom endpoint.

minLength1

api_url: str

Base URL for the OpenAI-compatible API, e.g. https://api.together.xyz/v1

formaturi

model_name: str

Model name as expected by the provider, e.g. meta-llama/llama-3-70b

minLength1

type: Literal["custom"]

OpenAI-compatible chat completions API (bring your own endpoint and key).

class CampaignAssistantLlmModelUnionMember3: …

provider: Literal["openai", "google"]

The provider to use from Realtime. eg: openai, google.

One of the following:

"openai"

"google"

realtime_model_id: str

The model ID to use from Realtime. eg: gpt-4.1

type: Literal["realtime"]

Use a model from Realtime.

realtime_voice_id: Optional[str]

Output voice for the realtime provider (e.g. OpenAI: marin; Gemini: Puck).

minLength1

logo_url: Optional[str]

Public URL of the brand logo shown on the assistant's demo page. Null when unset.

max_call_duration_secs: float

The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.

max_duration_end_message: Optional[str]

Optional message the agent will say, without being interruptible, when the call reaches its max duration. Kept short so it fits inside the farewell buffer. If null, the call ends silently.

maxLength150

name: str

organization_id: str

position: Optional[CampaignAssistantPosition]

x: float

y: float

prompt: str

prompt_flow: Optional[CampaignAssistantPromptFlow]

edges: List[CampaignAssistantPromptFlowEdge]

id: str

source: str

target: str

nodes: List[CampaignAssistantPromptFlowNode]

id: str

data: CampaignAssistantPromptFlowNodeData

body: str

title: str

position: CampaignAssistantPromptFlowNodePosition

x: float

y: float

type: Literal["promptBlock"]

slack: Optional[CampaignAssistantSlack]

channel_id: str

The Slack channel ID where the notification will be posted.

connection_id: str

The Nango connection ID linking the org's Slack workspace to Revox.

outcomes: List[Literal["not_interested", "interested", "completed", 2 more]]

Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']). Use 'none' to notify when outcome is null.

One of the following:

"not_interested"

"interested"

"completed"

"requested_callback_later"

"none"

channel_name: Optional[str]

Human-readable Slack channel name, cached for display in the UI.

template: Optional[str]

Optional message template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}}, {{last_name}}, {{email}}, {{company}}, {{job_title}}, {{contact_name}}, {{contact_line}}, plus prompt_variables and structured_output keys. When null/empty a default template is used.

sms_enabled: bool

Enable SMS tool during calls. When enabled, the agent can send SMS messages to the user on the call.

sms_template: Optional[str]

Hardcoded SMS template to send during calls. When set, this exact text is sent instead of letting the agent generate the message. Supports {{variable}} placeholders.

structured_output_config: Optional[List[CampaignAssistantStructuredOutputConfig]]

The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).

name: str

minLength1

required: bool

type: Literal["string", "number", "boolean", 3 more]

One of the following:

"string"

"number"

"boolean"

"enum"

"date"

"datetime"

description: Optional[str]

enum_options: Optional[List[str]]

structured_output_prompt: Optional[str]

Custom prompt for structured data extraction. If not provided, a default prompt is used. Available variables: {{transcript}}, {{call_direction}}, {{user_phone_number}}, {{agent_phone_number}}.

stt_context: Optional[CampaignAssistantSttContext]

Assistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.

general: List[CampaignAssistantSttContextGeneral]

key: str

minLength1

value: str

minLength1

terms: List[str]

stt_model: Literal["stt-rt-v4", "stt-rt-v5"]

Transcriber (speech-to-text) model used for the assistant.

One of the following:

"stt-rt-v4"

"stt-rt-v5"

thinking_sound: Optional[Literal["city-ambience.ogg", "forest-ambience.ogg", "office-ambience.ogg", 4 more]]

Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.

One of the following:

"city-ambience.ogg"

"forest-ambience.ogg"

"office-ambience.ogg"

"crowded-room.ogg"

"keyboard-typing.ogg"

"keyboard-typing2.ogg"

"hold_music.ogg"

thinking_sound_probability: float

Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.

minimum0

maximum1

thinking_sound_volume: float

Volume of the thinking sound (0 = silent, 1 = max).

minimum0

maximum1

transfer_phone_number: Optional[str]

Phone number to transfer calls to when users request to speak to a human agent.

type: Literal["standalone", "multi-step", "sub-assistant"]

One of the following:

"standalone"

"multi-step"

"sub-assistant"

updated_at: object

voice: Optional[CampaignAssistantVoice]

id: str

The ID of the voice.

minLength1

provider: Literal["cartesia", "elevenlabs"]

The provider of the voice.

One of the following:

"cartesia"

"elevenlabs"

model: Optional[Literal["sonic-3", "sonic-3.5"]]

Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored for other providers.

One of the following:

"sonic-3"

"sonic-3.5"

speed: Optional[float]

The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default is 1.0.

minimum0.6

maximum1.5

volume: Optional[float]

Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other providers.

minimum0.5

maximum2

voicemail_message: Optional[str]

If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.

voicemail_sms_prompt: Optional[str]

Prompt / instructions for the voicemail SMS. Supports {{variable}} placeholders. When null, no SMS is sent on voicemail.

warm_transfer_summary_instructions: Optional[str]

Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.

webhook_url: Optional[str]

The webhook URL to call when the call is completed.

zoho: Optional[CampaignAssistantZoho]

connection_id: str

The Nango connection ID linking the org's Zoho CRM account to Revox.

field_mapping: List[CampaignAssistantZohoFieldMapping]

Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.

source: str

Source key to read from the call: a structured_output field name, falling back to a prompt variable of the same name.

minLength1

zoho_field: str

Destination Zoho field API name on the upserted record (e.g. 'Email', 'Company', or a custom 'Budget__c').

minLength1

log_call_activity: bool

When true, also log the call as a record in Zoho's Calls module (related to the upserted prospect via Who_Id).

module: str

Zoho module the prospect record is upserted into (e.g. 'Leads' or 'Contacts').

minLength1

outcomes: List[Literal["not_interested", "interested", "completed", 2 more]]

Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use 'none' to push when outcome is null.

One of the following:

"not_interested"

"interested"

"completed"

"requested_callback_later"

"none"

template: Optional[str]

Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{transcript}}, plus prompt_variables and structured_output keys. When null/empty a default note (outcome + summary + auto-listed extracted fields) is used.

created_by: Optional[CampaignAssistantCreatedBy]

The user who created the assistant.

id: str

The database user id of the creator.

email: str

first_name: Optional[str]

last_name: Optional[str]

faq_items: Optional[List[CampaignAssistantFaqItem]]

answer: str

question: str

id: Optional[str]

needs_human_answer: Optional[bool]

source: Optional[Literal["human", "ai"]]

One of the following:

"human"

"ai"

is_inbound_receptionist: Optional[bool]

is_realestate_assistant: Optional[bool]

pending_faq_count: Optional[float]

call_retry_config: Optional[CampaignCallRetryConfig]

Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

allowed_days: List[Literal["monday", "tuesday", "wednesday", 4 more]]

Days of the week when calls are allowed, in the recipient's timezone. Default: Monday through Friday.

One of the following:

"monday"

"tuesday"

"wednesday"

"thursday"

"friday"

"saturday"

"sunday"

call_twice_in_a_row: bool

If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retry_delay_seconds) when attempt #1 didn't reach a human. Calling-window/allowed-days checks still apply. Only affects the 1→2 transition. Default: false.

calling_windows: List[CampaignCallRetryConfigCallingWindow]

calling_window_end_time: str

End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

calling_window_start_time: str

Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

retry_delay_seconds: int

Delay between retry attempts in seconds. 0 retries as soon as the calling window allows. Default: 7200 (2 hours).

minimum0

maximum9007199254740991

max_retry_attempts: int

Maximum number of call retry attempts. Default: 3.

exclusiveMinimum0

maximum9007199254740991

timezone: Optional[str]

Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

created_by: Optional[CampaignCreatedBy]

A member of the current organization.

id: str

The database user id (foreign key target on calls.assignee_id).

email: str

first_name: Optional[str]

last_name: Optional[str]

from_phone_number: Optional[str]

funnel_stats: Optional[CampaignFunnelStats]

hot: float

talked_to_human: float

total_leads: float

max_concurrent_calls: Optional[float]

paused_reason: Optional[Literal["manual", "no_presence"]]

One of the following:

"manual"

"no_presence"

present_count: Optional[float]

row_stats: Optional[CampaignRowStats]

calling: float

completed: float

failed: float

pending: float

retry: float

total: float

scheduled_at: Optional[object]

structured_output_extraction: Optional[Literal["none", "running", "completed"]]

The status of the structured output extraction.

One of the following:

"none"

"running"

"completed"

Update a campaign

Python

HTTP

TypeScript

Python

Ruby

import os
from revox import Revox

client = Revox(
    api_key=os.environ.get("REVOX_API_KEY"),  # This is the default and can be omitted
)
campaign = client.campaigns.update(
    id="id",
)
print(campaign.campaign)

200 example

{
  "campaign": {
    "id": "id",
    "assistant_id": "assistant_id",
    "created_at": {},
    "is_cancelled": true,
    "name": "name",
    "organization_id": "organization_id",
    "status": "draft",
    "type": "regular",
    "updated_at": {},
    "active_takeover_call_id": "active_takeover_call_id",
    "assistant": {
      "id": "id",
      "after_call_sms_outcomes": [
        "not_interested"
      ],
      "after_call_sms_prompt": "after_call_sms_prompt",
      "background_sound": "audio/office.ogg",
      "background_sound_volume": 0,
      "calendly": {
        "connection_id": "connection_id",
        "event_type_id": "event_type_id"
      },
      "call_retry_config": {
        "allowed_days": [
          "monday"
        ],
        "call_twice_in_a_row": true,
        "calling_windows": [
          {
            "calling_window_end_time": "calling_window_end_time",
            "calling_window_start_time": "calling_window_start_time",
            "retry_delay_seconds": 0
          }
        ],
        "max_retry_attempts": 1,
        "timezone": "timezone"
      },
      "cartesia_dictionary_pronunciation_id": "cartesia_dictionary_pronunciation_id",
      "created_at": {},
      "custom_tools": [
        {
          "body_template": "body_template",
          "description": "x",
          "headers": [
            {
              "key": "x",
              "value": "value"
            }
          ],
          "input_schema": [
            {
              "name": "x",
              "required": true,
              "type": "string",
              "description": "description",
              "enum_options": [
                "string"
              ]
            }
          ],
          "method": "GET",
          "name": "name",
          "query_params": [
            {
              "key": "x",
              "value": "value"
            }
          ],
          "url": "x"
        }
      ],
      "email_notification_address": "email_notification_address",
      "email_notification_outcomes": [
        "not_interested"
      ],
      "end_of_call_sentence": "end_of_call_sentence",
      "first_sentence": "first_sentence",
      "first_sentence_delay_ms": -9007199254740991,
      "first_sentence_mode": "generated",
      "from_phone_number": "from_phone_number",
      "human_transfer_mode": "warm",
      "ivr_navigation_enabled": true,
      "llm_model": {
        "name": "gpt-4.1",
        "type": "dedicated-instance"
      },
      "logo_url": "logo_url",
      "max_call_duration_secs": 0,
      "max_duration_end_message": "max_duration_end_message",
      "name": "name",
      "organization_id": "organization_id",
      "position": {
        "x": 0,
        "y": 0
      },
      "prompt": "prompt",
      "prompt_flow": {
        "edges": [
          {
            "id": "id",
            "source": "source",
            "target": "target"
          }
        ],
        "nodes": [
          {
            "id": "id",
            "data": {
              "body": "body",
              "title": "title"
            },
            "position": {
              "x": 0,
              "y": 0
            },
            "type": "promptBlock"
          }
        ]
      },
      "slack": {
        "channel_id": "channel_id",
        "connection_id": "connection_id",
        "outcomes": [
          "not_interested"
        ],
        "channel_name": "channel_name",
        "template": "template"
      },
      "sms_enabled": true,
      "sms_template": "sms_template",
      "structured_output_config": [
        {
          "name": "x",
          "required": true,
          "type": "string",
          "description": "description",
          "enum_options": [
            "string"
          ]
        }
      ],
      "structured_output_prompt": "structured_output_prompt",
      "stt_context": {
        "general": [
          {
            "key": "x",
            "value": "x"
          }
        ],
        "terms": [
          "x"
        ]
      },
      "stt_model": "stt-rt-v4",
      "thinking_sound": "city-ambience.ogg",
      "thinking_sound_probability": 0,
      "thinking_sound_volume": 0,
      "transfer_phone_number": "transfer_phone_number",
      "type": "standalone",
      "updated_at": {},
      "voice": {
        "id": "x",
        "provider": "cartesia",
        "model": "sonic-3",
        "speed": 0.6,
        "volume": 0.5
      },
      "voicemail_message": "voicemail_message",
      "voicemail_sms_prompt": "voicemail_sms_prompt",
      "warm_transfer_summary_instructions": "warm_transfer_summary_instructions",
      "webhook_url": "webhook_url",
      "zoho": {
        "connection_id": "connection_id",
        "field_mapping": [
          {
            "source": "x",
            "zoho_field": "x"
          }
        ],
        "log_call_activity": true,
        "module": "x",
        "outcomes": [
          "not_interested"
        ],
        "template": "template"
      },
      "created_by": {
        "id": "id",
        "email": "email",
        "first_name": "first_name",
        "last_name": "last_name"
      },
      "faq_items": [
        {
          "answer": "answer",
          "question": "question",
          "id": "id",
          "needs_human_answer": true,
          "source": "human"
        }
      ],
      "is_inbound_receptionist": true,
      "is_realestate_assistant": true,
      "pending_faq_count": 0
    },
    "call_retry_config": {
      "allowed_days": [
        "monday"
      ],
      "call_twice_in_a_row": true,
      "calling_windows": [
        {
          "calling_window_end_time": "calling_window_end_time",
          "calling_window_start_time": "calling_window_start_time",
          "retry_delay_seconds": 0
        }
      ],
      "max_retry_attempts": 1,
      "timezone": "timezone"
    },
    "created_by": {
      "id": "id",
      "email": "email",
      "first_name": "first_name",
      "last_name": "last_name"
    },
    "from_phone_number": "from_phone_number",
    "funnel_stats": {
      "hot": 0,
      "talked_to_human": 0,
      "total_leads": 0
    },
    "max_concurrent_calls": 0,
    "paused_reason": "manual",
    "present_count": 0,
    "row_stats": {
      "calling": 0,
      "completed": 0,
      "failed": 0,
      "pending": 0,
      "retry": 0,
      "total": 0
    },
    "scheduled_at": {},
    "structured_output_extraction": "none"
  }
}

Returns Examples

200 example

{
  "campaign": {
    "id": "id",
    "assistant_id": "assistant_id",
    "created_at": {},
    "is_cancelled": true,
    "name": "name",
    "organization_id": "organization_id",
    "status": "draft",
    "type": "regular",
    "updated_at": {},
    "active_takeover_call_id": "active_takeover_call_id",
    "assistant": {
      "id": "id",
      "after_call_sms_outcomes": [
        "not_interested"
      ],
      "after_call_sms_prompt": "after_call_sms_prompt",
      "background_sound": "audio/office.ogg",
      "background_sound_volume": 0,
      "calendly": {
        "connection_id": "connection_id",
        "event_type_id": "event_type_id"
      },
      "call_retry_config": {
        "allowed_days": [
          "monday"
        ],
        "call_twice_in_a_row": true,
        "calling_windows": [
          {
            "calling_window_end_time": "calling_window_end_time",
            "calling_window_start_time": "calling_window_start_time",
            "retry_delay_seconds": 0
          }
        ],
        "max_retry_attempts": 1,
        "timezone": "timezone"
      },
      "cartesia_dictionary_pronunciation_id": "cartesia_dictionary_pronunciation_id",
      "created_at": {},
      "custom_tools": [
        {
          "body_template": "body_template",
          "description": "x",
          "headers": [
            {
              "key": "x",
              "value": "value"
            }
          ],
          "input_schema": [
            {
              "name": "x",
              "required": true,
              "type": "string",
              "description": "description",
              "enum_options": [
                "string"
              ]
            }
          ],
          "method": "GET",
          "name": "name",
          "query_params": [
            {
              "key": "x",
              "value": "value"
            }
          ],
          "url": "x"
        }
      ],
      "email_notification_address": "email_notification_address",
      "email_notification_outcomes": [
        "not_interested"
      ],
      "end_of_call_sentence": "end_of_call_sentence",
      "first_sentence": "first_sentence",
      "first_sentence_delay_ms": -9007199254740991,
      "first_sentence_mode": "generated",
      "from_phone_number": "from_phone_number",
      "human_transfer_mode": "warm",
      "ivr_navigation_enabled": true,
      "llm_model": {
        "name": "gpt-4.1",
        "type": "dedicated-instance"
      },
      "logo_url": "logo_url",
      "max_call_duration_secs": 0,
      "max_duration_end_message": "max_duration_end_message",
      "name": "name",
      "organization_id": "organization_id",
      "position": {
        "x": 0,
        "y": 0
      },
      "prompt": "prompt",
      "prompt_flow": {
        "edges": [
          {
            "id": "id",
            "source": "source",
            "target": "target"
          }
        ],
        "nodes": [
          {
            "id": "id",
            "data": {
              "body": "body",
              "title": "title"
            },
            "position": {
              "x": 0,
              "y": 0
            },
            "type": "promptBlock"
          }
        ]
      },
      "slack": {
        "channel_id": "channel_id",
        "connection_id": "connection_id",
        "outcomes": [
          "not_interested"
        ],
        "channel_name": "channel_name",
        "template": "template"
      },
      "sms_enabled": true,
      "sms_template": "sms_template",
      "structured_output_config": [
        {
          "name": "x",
          "required": true,
          "type": "string",
          "description": "description",
          "enum_options": [
            "string"
          ]
        }
      ],
      "structured_output_prompt": "structured_output_prompt",
      "stt_context": {
        "general": [
          {
            "key": "x",
            "value": "x"
          }
        ],
        "terms": [
          "x"
        ]
      },
      "stt_model": "stt-rt-v4",
      "thinking_sound": "city-ambience.ogg",
      "thinking_sound_probability": 0,
      "thinking_sound_volume": 0,
      "transfer_phone_number": "transfer_phone_number",
      "type": "standalone",
      "updated_at": {},
      "voice": {
        "id": "x",
        "provider": "cartesia",
        "model": "sonic-3",
        "speed": 0.6,
        "volume": 0.5
      },
      "voicemail_message": "voicemail_message",
      "voicemail_sms_prompt": "voicemail_sms_prompt",
      "warm_transfer_summary_instructions": "warm_transfer_summary_instructions",
      "webhook_url": "webhook_url",
      "zoho": {
        "connection_id": "connection_id",
        "field_mapping": [
          {
            "source": "x",
            "zoho_field": "x"
          }
        ],
        "log_call_activity": true,
        "module": "x",
        "outcomes": [
          "not_interested"
        ],
        "template": "template"
      },
      "created_by": {
        "id": "id",
        "email": "email",
        "first_name": "first_name",
        "last_name": "last_name"
      },
      "faq_items": [
        {
          "answer": "answer",
          "question": "question",
          "id": "id",
          "needs_human_answer": true,
          "source": "human"
        }
      ],
      "is_inbound_receptionist": true,
      "is_realestate_assistant": true,
      "pending_faq_count": 0
    },
    "call_retry_config": {
      "allowed_days": [
        "monday"
      ],
      "call_twice_in_a_row": true,
      "calling_windows": [
        {
          "calling_window_end_time": "calling_window_end_time",
          "calling_window_start_time": "calling_window_start_time",
          "retry_delay_seconds": 0
        }
      ],
      "max_retry_attempts": 1,
      "timezone": "timezone"
    },
    "created_by": {
      "id": "id",
      "email": "email",
      "first_name": "first_name",
      "last_name": "last_name"
    },
    "from_phone_number": "from_phone_number",
    "funnel_stats": {
      "hot": 0,
      "talked_to_human": 0,
      "total_leads": 0
    },
    "max_concurrent_calls": 0,
    "paused_reason": "manual",
    "present_count": 0,
    "row_stats": {
      "calling": 0,
      "completed": 0,
      "failed": 0,
      "pending": 0,
      "retry": 0,
      "total": 0
    },
    "scheduled_at": {},
    "structured_output_extraction": "none"
  }
}