Skip to main content
PATCH
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Path Parameters

campaign_id
string
required

The campaign's id: the id from List campaigns. It is also the last part of that page's address in the app.

Body

application/json
lead_list_id
string | null

A lead list's id: the id from List lead lists.

name
string | null

Name returned by the Sendora API.

reply_agent_id
string | null

The voice agent that handles replies from leads in this campaign: an id from List voice agents. When empty, the workspace's first agent is used.

variable_defaults
Variable Defaults · object | null

Variable defaults returned by the Sendora API.

workflow
CampaignWorkflow · object | null

Workflow returned by the Sendora API.

workflow_ui_json
Workflow Ui Json · object | null

Workflow ui json returned by the Sendora API.

Response

Successful Response

created_at
string<date-time>
required

Created at returned by the Sendora API.

id
string
required

The campaign's id. Pass it to any endpoint that takes campaign_id.

name
string
required

Name returned by the Sendora API.

status
string
required

Status returned by the Sendora API.

updated_at
string<date-time>
required

Updated at returned by the Sendora API.

build_mode
enum<string>
default:linear

Build mode returned by the Sendora API.

Available options:
linear,
advanced
build_mode_reason
string | null

Build mode reason returned by the Sendora API.

channels
string[]

Channels returned by the Sendora API.

connect_rate
number
default:0

Connect rate returned by the Sendora API.

contacted_count
integer
default:0

Contacted count returned by the Sendora API.

created_from_template_slug
string | null

Created from template slug returned by the Sendora API.

folder_id
string | null

The folder to place the campaign in: an id from List campaign folders. Leave empty for no folder.

inbound_agent_id
string | null

The voice agent that answers incoming calls: an id from List voice agents.

inbound_agent_name
string | null

Inbound agent name returned by the Sendora API.

lead_count
integer
default:0

Lead count returned by the Sendora API.

lead_list_id
string | null

A lead list's id: the id from List lead lists.

meeting_count
integer
default:0

Meeting count returned by the Sendora API.

reply_agent_id
string | null

The voice agent that handles replies from leads in this campaign: an id from List voice agents. When empty, the workspace's first agent is used.

reply_count
integer
default:0

Reply count returned by the Sendora API.

smoke_test_active
boolean
default:false

Smoke test active returned by the Sendora API.

smoke_test_started_at
string<date-time> | null

Smoke test started at returned by the Sendora API.

variable_defaults
Variable Defaults · object

Variable defaults returned by the Sendora API.

workflow
CampaignWorkflow · object | null

Workflow returned by the Sendora API.

workflow_ui_json
Workflow Ui Json · object | null

Workflow ui json returned by the Sendora API.