Skip to main content
PATCH
/
campaigns
/
{campaignId}
Update Campaign
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": false,
  "stopOnMeetingBooked": true,
  "stopOnLinkClicked": false
}'
{
  "name": "NEW TO DELETE",
  "stopOnEmailReplied": true,
  "stopOnMeetingBooked": true,
  "stopOnLinkClicked": true,
  "disableTrackReply": true
}
This endpoint uses the Campaign object.
This endpoint updates the settings of a campaign.

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

​
stopOnLinkClickedFilter
string

Filter for which link clicks should stop the campaign

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

​
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

​
stopOnLinkClickedFilter
string

Filter for which link clicks should stop the campaign