curl --request POST \
--url https://api.lemlist.com/api/watchlist \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "New hires at target accounts",
"type": "newHire"
}
'import requests
url = "https://api.lemlist.com/api/watchlist"
payload = {
"name": "New hires at target accounts",
"type": "newHire"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'New hires at target accounts', type: 'newHire'})
};
fetch('https://api.lemlist.com/api/watchlist', 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/watchlist")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"New hires at target accounts\",\n \"type\": \"newHire\"\n}"
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lemlist.com/api/watchlist",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'New hires at target accounts',
'type' => 'newHire'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"_id": "<string>",
"name": "<string>",
"type": "companyIsHiring",
"status": "active",
"entity": "contact",
"segmentType": "all",
"signalProcessingType": "manual",
"signalOpportunityTemplate": {
"ownerType": "contact_owner",
"ownerId": "<string>",
"type": "email",
"priority": 0,
"data": {
"title": "<string>",
"subject": "<string>",
"emailTemplateId": "<string>",
"message": "<string>"
}
},
"filters": [
{
"filterId": "title",
"in": [
"<string>"
],
"out": [
"<string>"
]
}
],
"emoji": "<string>"
}
}activate requires both segmentType and signalProcessingTypeUnauthorizedInsufficient credits{
"error": "Campaign not found",
"code": "WATCH_LIST_IMPORT_LEADS_CAMPAIGN_NOT_FOUND"
}{
"error": "This campaign was set up as a manual campaign and cannot take a signal trigger; create a signal-based campaign instead",
"code": "WATCH_LIST_CAMPAIGN_IS_MANUAL"
}Monitoring limit exceededInternal server error{
"error": "The search taxonomy backend is temporarily unavailable — retry shortly",
"code": "WATCH_LIST_API_TAXONOMY_UNAVAILABLE"
}Create Signal Agent
Creates a new Signal Agent (watch list).
curl --request POST \
--url https://api.lemlist.com/api/watchlist \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "New hires at target accounts",
"type": "newHire"
}
'import requests
url = "https://api.lemlist.com/api/watchlist"
payload = {
"name": "New hires at target accounts",
"type": "newHire"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'New hires at target accounts', type: 'newHire'})
};
fetch('https://api.lemlist.com/api/watchlist', 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/watchlist")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"New hires at target accounts\",\n \"type\": \"newHire\"\n}"
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lemlist.com/api/watchlist",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'New hires at target accounts',
'type' => 'newHire'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"_id": "<string>",
"name": "<string>",
"type": "companyIsHiring",
"status": "active",
"entity": "contact",
"segmentType": "all",
"signalProcessingType": "manual",
"signalOpportunityTemplate": {
"ownerType": "contact_owner",
"ownerId": "<string>",
"type": "email",
"priority": 0,
"data": {
"title": "<string>",
"subject": "<string>",
"emailTemplateId": "<string>",
"message": "<string>"
}
},
"filters": [
{
"filterId": "title",
"in": [
"<string>"
],
"out": [
"<string>"
]
}
],
"emoji": "<string>"
}
}activate requires both segmentType and signalProcessingTypeUnauthorizedInsufficient credits{
"error": "Campaign not found",
"code": "WATCH_LIST_IMPORT_LEADS_CAMPAIGN_NOT_FOUND"
}{
"error": "This campaign was set up as a manual campaign and cannot take a signal trigger; create a signal-based campaign instead",
"code": "WATCH_LIST_CAMPAIGN_IS_MANUAL"
}Monitoring limit exceededInternal server error{
"error": "The search taxonomy backend is temporarily unavailable — retry shortly",
"code": "WATCH_LIST_API_TAXONOMY_UNAVAILABLE"
}segmentType, signalProcessingType and activate: true to run the full setup and start monitoring immediately. filters are validated against the chosen type — use List allowed filters to discover which filters a type accepts.campaignId with signalProcessingType: "push_to_campaign" to link the new agent to that campaign as its signal trigger in the same call — same effect as Add Signal Agent trigger. If the call is refused (400, 404 or 409), no agent is created. campaignId is not accepted by Update Signal Agent: to link an existing agent, use Add Signal Agent trigger.externalSignalContact / externalSignalCompany), map the keys your tool will push with the externalSignalFieldMapping filter, in being an array of { sourceKey, targetKey } objects: contact.linkedinUrl is required for a contact agent, company.domain and company.name for a company agent. Extra keys to keep on each signal go in externalSignalCustomFieldMapping. Then push events with Push external signals.companyRunningAds agent (companies advertising on LinkedIn, Meta, Google, TikTok or Apple), maxIdentificationsPerDay (in, one value, default 10) is required. Optional in filters: adPlatforms (linkedin, facebook for every Meta surface, google, tiktok — EEA, UK and Switzerland only —, apple; empty means all), adFormats (empty means all), adTargetCountries (country names), adSearchTerms (keywords matched on the ad title and description). companyLocation, companyIndustries (Pubrio vertical names, not the industries of the other company types: resolve them with Autocomplete filter values using type=companyRunningAds and a query, and send the returned names verbatim — an unmatched value is a 400 WATCH_LIST_API_INVALID_FILTERS, a Pubrio outage during validation a 503 WATCH_LIST_API_TAXONOMY_UNAVAILABLE) and companySizes accept in and out; companyLinkedinUrls is out only. crmListIds is not accepted: attach CRM lists with Associate CRM lists — a CRM list or CSV monitors the listed companies’ domains only. Each signal costs 100 credits and a company is reported at most once per 30 days per agent; the agent moves to insufficient_credits when the team runs out and resumes on refill.marketExpansion agent (companies entering a new country market), targetMarkets (in, country names) and maxIdentificationsPerDay (in, one value, default 20) are required. Optional in filters: originMarkets (country names, the companies’ home market), expansionStages (exploring, committing, expanding, scaling; empty means all), expansionSignalStrengths (low, medium, high, very_high; empty means all, no default is applied). companyLocation, companyIndustries (Pubrio vertical names, resolved as for companyRunningAds with Autocomplete filter values using type=marketExpansion and a query) and companySizes accept in and out; companyLinkedinUrls is out only. crmListIds is not accepted: attach CRM lists with Associate CRM lists — a CRM list or CSV monitors the listed companies’ domains only. Each signal covers one target market and costs 100 credits; a company is reported at most once per 30 days per agent, whatever the market; the agent moves to insufficient_credits when the team runs out and resumes on refill.personBuyingIntent agent (people showing buying signals in their LinkedIn activity and their visits across a network of websites), personIntentTopics (in, up to 25) is required: resolve the topic names with Autocomplete filter values using filterId=personIntentTopics and a query of 3 characters or more, and send the returned names verbatim — a name outside the topic taxonomy is a 400 WATCH_LIST_API_INVALID_FILTERS. maxIdentificationsPerDay (in, one integer, default 20) is required. Optional in filters, up to 25 values each: title and companyIndustries (200 characters at most), companyLocation and location (country names; a region such as North America is expanded into its countries on companyLocation and refused on location), companySizes (the six ranges Autocomplete filter values returns with type=personBuyingIntent: 1-10, 11-50, 51-200, 201-1000, 1001-5000, 5001+). lookbackDays (in, one integer from 1 to 30, 30 when absent) is the number of days of past activity delivered once, at the first activation: a later change does not reach a running agent. No filter takes out, and crmListIds is not accepted: attach CRM lists with Associate CRM lists. Each signal costs 100 credits.Authorizations
Body
Signal type to monitor
companyIsHiring, companyRaisedFunds, recruitmentCampaign, newHire, companyEmployeeVisitedMyWebsite, customSignals, competitorConnections, competitorReactions, warmIntros, technologyChange, linkedinPeopleProfile, linkedinCompanyProfile, mergersAcquisitions, promotion, linkedinKeywords, republishedJobOffers, externalSignalContact, externalSignalCompany, buyingIntent, newProductLaunch, companyAward, newPartnership, newOffice, closingOffice, costCutting, outagesAndSecurityBreaches, lawsuitsAndLegalIssues, githubStargazer, linkedinProfileViews, companyRunningAds, marketExpansion, personBuyingIntent Persona (pdp_xxx) used to source contacts from the People Database. Only for a company Signal Agent with signalProcessingType = push_to_campaign whose signal type does not already ship its own contact (those company signals carry no contact, so the persona is the only way to know who to reach). Optional; rejected on any other configuration.
Campaign (cam_xxx) to link as this Signal Agent's signal trigger, in the same call: every new signal pushes its contact into that campaign as a lead. Only with signalProcessingType = push_to_campaign. A campaign set up as manual in the lemlist app is refused (409). Optional; on any refusal no agent is created.
"cam_ExAmPlE4k8Qz2Wn7R"
Was this page helpful?