Get Campaign Settings
curl --request GET \
--url https://api.lemlist.com/api/campaigns/{campaignId}/settings \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.lemlist.com/api/campaigns/{campaignId}/settings"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.lemlist.com/api/campaigns/{campaignId}/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://api.lemlist.com/api/campaigns/{campaignId}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lemlist.com/api/campaigns/{campaignId}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"campaignId": "cam_hNtZRPpyNP6HRp4PV",
"timezone": "Europe/Paris",
"senderStrategy": "random",
"general": {
"labels": [
{
"id": "lab_aHYwTgdfZU1GpO47A",
"name": "Outbound"
}
],
"sequenceId": "seq_4LUxRGgCy7MGaQq0c",
"sequenceSharing": false,
"unsubscribeMode": "contact",
"addUnsubscribeLink": true,
"unsubscribeLinkText": "Unsubscribe"
},
"senders": {
"espMatching": true,
"espRouting": {
"gmail": "gmail",
"outlook": "outlook",
"other": "other"
}
},
"automation": {
"autoReview": false,
"autoReviewConditions": [
"unverified"
]
},
"tracking": {
"trackOpens": true,
"trackClicks": true,
"trackReplies": true
},
"onReplied": {
"createNewTask": false,
"campaignProgress": "stop",
"propagateProgressToCompany": false,
"disableOutOfOffice": false
},
"onLinkClicked": {
"createNewTask": false,
"campaignProgress": "continue",
"propagateProgressToCompany": false,
"specificLinks": []
},
"onMeetingBooked": {
"campaignProgress": "stop",
"propagateProgressToCompany": true
},
"aiFeatures": {
"scoreReplies": true,
"onInterestedReply": {
"enabled": true,
"pauseAllCampaignsForLead": true,
"pauseCampaignForCompany": false,
"pauseAllCampaignsForCompany": false
},
"onNotInterestedReply": {
"enabled": false,
"pauseAllCampaignsForLead": false,
"pauseCampaignForCompany": false,
"pauseAllCampaignsForCompany": false
}
},
"schedule": {
"isTimezoneBasedSchedule": false,
"timezoneBasedScheduleId": null,
"scheduleIds": [
"skd_NHanXKczmWCI0tl1m"
],
"holidayCountries": [
"FR"
],
"sendingPattern": {
"newLeadsPriorityRatio": 0.5
}
}
}{
"error": "Wrong param campaign id",
"code": "WRONG_PARAM_CAMPAIGN_ID"
}The authentication you supplied is incorrectroute is available starting emailPro plan{
"error": "Campaign not found",
"code": "CAMPAIGN_NOT_FOUND"
}{
"error": "Route bad method",
"code": "ROUTE_BAD_METHOD"
}Campaigns
Get Campaign Settings
Returns all the settings of a campaign.
GET
/
campaigns
/
{campaignId}
/
settings
Get Campaign Settings
curl --request GET \
--url https://api.lemlist.com/api/campaigns/{campaignId}/settings \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.lemlist.com/api/campaigns/{campaignId}/settings"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.lemlist.com/api/campaigns/{campaignId}/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://api.lemlist.com/api/campaigns/{campaignId}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lemlist.com/api/campaigns/{campaignId}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"campaignId": "cam_hNtZRPpyNP6HRp4PV",
"timezone": "Europe/Paris",
"senderStrategy": "random",
"general": {
"labels": [
{
"id": "lab_aHYwTgdfZU1GpO47A",
"name": "Outbound"
}
],
"sequenceId": "seq_4LUxRGgCy7MGaQq0c",
"sequenceSharing": false,
"unsubscribeMode": "contact",
"addUnsubscribeLink": true,
"unsubscribeLinkText": "Unsubscribe"
},
"senders": {
"espMatching": true,
"espRouting": {
"gmail": "gmail",
"outlook": "outlook",
"other": "other"
}
},
"automation": {
"autoReview": false,
"autoReviewConditions": [
"unverified"
]
},
"tracking": {
"trackOpens": true,
"trackClicks": true,
"trackReplies": true
},
"onReplied": {
"createNewTask": false,
"campaignProgress": "stop",
"propagateProgressToCompany": false,
"disableOutOfOffice": false
},
"onLinkClicked": {
"createNewTask": false,
"campaignProgress": "continue",
"propagateProgressToCompany": false,
"specificLinks": []
},
"onMeetingBooked": {
"campaignProgress": "stop",
"propagateProgressToCompany": true
},
"aiFeatures": {
"scoreReplies": true,
"onInterestedReply": {
"enabled": true,
"pauseAllCampaignsForLead": true,
"pauseCampaignForCompany": false,
"pauseAllCampaignsForCompany": false
},
"onNotInterestedReply": {
"enabled": false,
"pauseAllCampaignsForLead": false,
"pauseCampaignForCompany": false,
"pauseAllCampaignsForCompany": false
}
},
"schedule": {
"isTimezoneBasedSchedule": false,
"timezoneBasedScheduleId": null,
"scheduleIds": [
"skd_NHanXKczmWCI0tl1m"
],
"holidayCountries": [
"FR"
],
"sendingPattern": {
"newLeadsPriorityRatio": 0.5
}
}
}{
"error": "Wrong param campaign id",
"code": "WRONG_PARAM_CAMPAIGN_ID"
}The authentication you supplied is incorrectroute is available starting emailPro plan{
"error": "Campaign not found",
"code": "CAMPAIGN_NOT_FOUND"
}{
"error": "Route bad method",
"code": "ROUTE_BAD_METHOD"
}This endpoint requires at least the Email Pro plan.
data.
general.labels,general.sequenceId,senders.espRoutingandschedule.scheduleIdsare read-only.senders.espMatchinggives the team value when the campaign does not set it.- A campaign hidden from the user of the API key answers
404. An API key not linked to a user acts as the first user of the team.
Authorizations
Response
Success
All the settings of a campaign.
Sending schedule options. Read and change the schedules themselves with the Schedules endpoints.
Show child attributes
Show child attributes
Was this page helpful?