Update Campaign

Updates the settings and configuration of an existing campaign.

PATCH /campaigns/{campaignId}

Update Campaign

cURL

curl --request PATCH \
  --url https://api.lemlist.com/api/campaigns/{campaignId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "New campaign name",
  "stopOnEmailReplied": true,
  "stopOnMeetingBooked": true,
  "stopOnLinkClicked": false,
  "leadsPausedByInterest": false,
  "opportunityReplied": true,
  "opportunityClicked": false,
  "autoLeadInterest": true,
  "disableTrackOpen": false,
  "disableTrackClick": false,
  "disableTrackReply": false,
  "disableOutOfOffice": false,
  "sequenceSharing": false,
  "sendUserIds": [
    "usr_2aBCdEfGHiJkLmNOp",
    "usr_7xYzAbCdEfGhIjKlM"
  ],
  "autoReview": true,
  "autoReviewConditions": [
    "deliverable",
    "risky"
  ]
}
'

200

Example

{ "name": "New campaign name", "stopOnEmailReplied": true, "stopOnMeetingBooked": true, "stopOnLinkClicked": false, "leadsPausedByInterest": false, "opportunityReplied": true, "opportunityClicked": false, "autoLeadInterest": true, "disableTrackOpen": false, "disableTrackClick": false, "disableTrackReply": false, "disableOutOfOffice": false, "sequenceSharing": false, "sendUsers": [ { "id": "usr_2aBCdEfGHiJkLmNOp", "mailboxes": [ { "sendUserMailboxId": "smb_1aBcDeFgHiJkLmNoP", "email": "[e-mail]" } ], "phoneNumbers": [ "[phone]" ], "whatsappAccountIds": [ "wha_3xYzAbCdEfGhIjKlM" ] }, { "id": "usr_7xYzAbCdEfGhIjKlM", "mailboxes": [ { "sendUserMailboxId": "smb_9zYxWvUtSrQpOnMlK", "email": "[e-mail]" } ], "phoneNumbers": [], "whatsappAccountIds": [] } ] }

Set autoReview to true to automatically launch leads as soon as they are added to the campaign, skipping manual review. Use autoReviewConditions to restrict auto-launch to leads whose email verification matches one of the given deliverability statuses (deliverable, risky, undeliverable, unverified).

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

stopOnEmailReplied · boolean

Stop the campaign when a lead replies by email

stopOnMeetingBooked · boolean

Stop the campaign when a meeting is booked

stopOnLinkClicked · boolean

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

stopOnLinkClickedFilter · string

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 all channels must be covered by at least one sender.

autoReview · boolean

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

autoReviewConditions · enum<string>[]

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

Response

200

application/json

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

stopOnLinkClicked · boolean

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

stopOnLinkClickedFilter · string

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.

Show child attributes