Skip to main content
PUT
Update a campaign

Authorizations

Authorization
string
header
required

Your organization API key (it starts with anek_org_). The same key works on the Voice API and the Support API. See Authentication.

Path Parameters

projectId
string
required

Project id

id
string
required

Campaign id

Body

application/json

Send only the fields to change.

name
string
Minimum string length: 1
agent_id
string | null
Minimum string length: 1
from_number
string | null
Minimum string length: 1
start_time
string<date-time> | null

Set to schedule the campaign; null returns it to draft.

callback
boolean

Changing it applies the new value to every existing contact.

retries
integer
Required range: x >= 0
retry_delay_seconds
integer
Required range: x >= 0
max_concurrency
integer
Required range: 5 <= x <= 20
calling_window
object | null

A recurring window in which the campaign may dial. Outside it, contacts wait for the next window. When end is not after start the window runs past midnight (for example 22:00 to 02:00).

Response

The updated campaign

campaign
object
required

An outbound calling campaign.