Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

Agent id.

Minimum string length: 1

Query Parameters

locationId
string

Pair with campaignId; omit both for primary campaign.

Minimum string length: 1
campaignId
string

Pair with locationId; omit both for primary campaign.

Minimum string length: 1

Body

application/json
name
string
Minimum string length: 1
Example:

"Speed to Lead"

active
boolean

Switch the campaign live. Defaults to paused.

Example:

true

description
string
Example:

"Call new leads as soon as they enter the intake flow."

activeTags
string[]
Example:
inactiveTags
string[]
Example:
callIfDnd
boolean
Example:

false

agentId
string | null
Example:

"agent_2b7c9f4a"

dialing
enum<string>

Dispatch mode.

Available options:
s2l,
pd,
s2l_pd
Example:

"s2l_pd"

callingWindow
object
multipleTimezoneCheck
boolean
Example:

true

dropOutsideWindow
boolean
Example:

false

masterCampaignEnabled
boolean
Example:

true

config
object
fromNumbers
string[]
Example:
{key}
any

Response

Campaign facet updated.

success
boolean
required
campaign
object
required