Skip to main content
PATCH
Update Campaign Settings
This endpoint requires at least the Email Pro plan.
Send only the sections and fields to change. An omitted section or field keeps its value. The response gives all the settings after the change, as Get Campaign Settings does.

Validation

  • An unknown field or a read-only field answers 400 CAMPAIGN_SETTINGS_INVALID_INPUT. details.issues lists every refused field, so that you can fix them all in one retry.
  • An empty body answers 400.
  • All the checks run before the first write. A refused request writes nothing.

Conditions

The checks read the settings after the change. To turn on auto-review on a team without a custom tracking domain, send tracking: { "trackOpens": false, "trackClicks": false } in the same request.
On a campaign with a dynamic sender strategy, set the senders that the leads cannot select with Replace Campaign Sender Exclusions.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

campaignId
string
required

The unique identifier of the campaign

Body

application/json

The settings to change. Send at least one section. An omitted section or field keeps its value. An unknown or read-only field answers 400.

senderStrategy
string

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

Sequence sharing and unsubscribe link.

senders
object

Sender matching.

automation
object

Auto-review.

tracking
object

Open, click and reply tracking.

onReplied
object

What happens when a lead replies.

What happens when a lead clicks a tracked link.

onMeetingBooked
object

What happens when a lead books a meeting.

aiFeatures
object

AI reply handling.

schedule
object

Sending schedule options. Change the schedules themselves with the Schedules endpoints.

Response

Success

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.