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 or get campaigns. It is also the last part of that page's address in the app.

Body

application/json
name
string
required

Name returned by the Sendora API.

Required string length: 1 - 120
type
string
required

folder renames the campaign folder whose id is in the path.

Allowed value: "folder"

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.

enrollment
Enrollment · object | null

Present when leads were enrolled in this call: enrolled, skipped and total_requested.

folder_id
string | null

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

inbound_agent_id
string | null

The voice agent that answers incoming calls: an id from List or get 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 or read lead collections (type list).

meeting_count
integer
default:0

Meeting count returned by the Sendora API.

preflight
Preflight · object | null

Launch checks: ok, lead_count, total_nodes, errors and warnings. Present with include=preflight.

reply_agent_id
string | null

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

reply_count
integer
default:0

Reply count returned by the Sendora API.

reply_mode
enum<string>
default:off

Reply mode returned by the Sendora API.

Available options:
off,
draft,
auto
reply_note
string
default:""

Reply note 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.

warnings
string[]

Warnings 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.