Skip to main content
PATCH
Update Campaign
The settings fields of this endpoint are deprecated. They still work, but use Update Campaign Settings instead: it covers all the settings, and refuses an unknown or invalid field instead of ignoring it.
emoji is a campaign field, not a setting: the deprecation above does not apply to it. It can be changed but not removed. sendUserIds replaces the sender pool and keeps the first account of each channel type for each sender. To add a sender without a replacement, or to pick a mailbox, a WhatsApp account or an alias, use the Senders endpoints.

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
name
string

The campaign name

emoji
string

Emoji shown next to the campaign name (e.g. 🚀). It can be changed but not removed: an empty or whitespace-only string or null returns a 400 error, as does a value containing < or >.

stopOnEmailReplied
boolean
deprecated

Stop the campaign when a lead replies by email

stopOnMeetingBooked
boolean
deprecated

Stop the campaign when a meeting is booked

Stop the campaign when a link is clicked

leadsPausedByInterest
boolean
deprecated

Pause leads based on interest

opportunityReplied
boolean
deprecated

Create an opportunity when a lead replies

opportunityClicked
boolean
deprecated

Create an opportunity when a lead clicks a link

autoLeadInterest
boolean
deprecated

Automatically detect lead interest

disableTrackOpen
boolean
deprecated

Disable tracking of email opens

disableTrackClick
boolean
deprecated

Disable tracking of link clicks

disableTrackReply
boolean
deprecated

Disable tracking of email replies

disableOutOfOffice
boolean
deprecated

Disable out-of-office detection

sequenceSharing
boolean
deprecated

Enable sequence sharing for the campaign

Filter for which link clicks should stop the campaign

sendUserIds
string[]

Array of user IDs (usr_xxx format) to assign as campaign senders. Cannot be used on campaigns with a dynamic sender strategy (contactOwner, leadImporter, customField). Each sender is validated against the campaign's sending channels (email, LinkedIn, SMS, WhatsApp): senders without capabilities for at least one channel are excluded, and every channel that a lead can reach in the sequence must be covered by at least one sender. Replaces the sender pool, with the first account of each channel type for each sender. To add a sender without a replacement, pick an account or an alias, use the Senders endpoints.

autoReview
boolean
deprecated

Automatically launch (review) leads as soon as they are added to the campaign, instead of requiring manual review.

autoReviewConditions
enum<string>[]
deprecated

Email deliverability statuses for which a lead is auto-launched when autoReview is enabled. Only leads whose email verification matches one of these statuses are launched automatically. Invalid values are rejected with a 400 error.

Available options:
deliverable,
risky,
undeliverable,
unverified
aiFeatures
object
deprecated

AI reply-handling settings. Provide only the flags to change; omitted flags keep their current value.

tracking
object
deprecated

Open / click / reply tracking toggles.

onReplied
object
deprecated

Behavior when a lead replies.

Behavior when a lead clicks a tracked link.

onMeetingBooked
object
deprecated

Behavior when a meeting is booked.

Response

Success

name
string

The campaign name

stopOnEmailReplied
boolean

Stop the campaign when a lead replies by email

stopOnMeetingBooked
boolean

Stop the campaign when a meeting is booked

Stop the campaign when a link is clicked

leadsPausedByInterest
boolean

Pause leads based on interest

opportunityReplied
boolean

Create an opportunity when a lead replies

opportunityClicked
boolean

Create an opportunity when a lead clicks a link

autoLeadInterest
boolean

Automatically detect lead interest

disableTrackOpen
boolean

Disable tracking of email opens

disableTrackClick
boolean

Disable tracking of link clicks

disableTrackReply
boolean

Disable tracking of email replies

disableOutOfOffice
boolean

Disable out-of-office detection

sequenceSharing
boolean

Enable sequence sharing for the campaign

Filter for which link clicks should stop the campaign

sendUsers
object[]

Configured senders for the campaign. Only present when sendUserIds was provided in the request. Senders that lack capabilities for any campaign sending channel are excluded.