Skip to main content
All the settings of a campaign, grouped by section. Read them with Get Campaign Settings and change them with Update Campaign Settings. The sender pool and the sender exclusions have their own endpoints, in the Senders group. The schedules have their own endpoints, in the Schedules group.

All the settings of a campaign.

campaignId
string
required

The campaign ID.

timezone
string | null
required

The campaign timezone, null when not set.

senderStrategy
string
required

How the campaign picks the sender of each lead: random (the sender pool), contactOwner, leadImporter or customField:<fieldName>.

Pattern: ^(random|contactOwner|leadImporter|customField:.+)$
general
object
required

Labels, sequence and unsubscribe link.

senders
object
required

Sender matching.

automation
object
required

Auto-review.

tracking
object
required

Open, click and reply tracking.

onReplied
object
required

What happens when a lead replies.

What happens when a lead clicks a tracked link.

onMeetingBooked
object
required

What happens when a lead books a meeting.

aiFeatures
object
required

AI reply handling.

schedule
object
required

Sending schedule options. Read and change the schedules themselves with the Schedules endpoints.