Create Signal Agent

Creates a new Signal Agent (watch list).

POST /watchlist

Create Signal Agent

cURL

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;
}

201

{
  "data": {
    "_id": "<string>",
    "name": "<string>",
    "signalOpportunityTemplate": {
      "ownerId": "<string>",
      "data": {
        "title": "<string>",
        "subject": "<string>",
        "emailTemplateId": "<string>",
        "message": "<string>"
      }
    },
    "filters": [
      {
        "in": [
          "<string>"
        ],
        "out": [
          "<string>"
        ]
      }
    ],
    "emoji": "<string>"
  }
}

"activate requires both segmentType and signalProcessingType"

"Unauthorized"

"Insufficient credits"

"Monitoring limit exceeded"

"Internal server error"

A Signal Agent is created as a draft by default. Pass 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.

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

name · string · required

Display name

type · enum<string> · required

Signal type to monitor

Available options: companyIsHiring, companyRaisedFunds, recruitmentCampaign, jobChange, newHire, companyEmployeeVisitedMyWebsite, customSignals, competitorConnections, competitorReactions, companyFollowers, technologyChange, linkedinPeopleProfile, linkedinCompanyProfile, mergersAcquisitions, promotion, linkedinKeywords, externalSignalContact, externalSignalCompany, buyingIntent

filters · object[]

Filters to apply (validated against the signal type)

Show child attributes

emoji · string

Emoji shown next to the agent name (defaults to a random emoji)

segmentType · enum<string>

Entity sourcing. Only all is supported via the API. Required together with signalProcessingType when activate is true.

Available options: all

signalProcessingType · enum<string>

How detected signals are processed

Available options: manual, create_opportunity, push_to_campaign

signalOpportunityTemplate · object

Task/opportunity template applied to each signal when signalProcessingType is create_opportunity.

Show child attributes

activate · boolean

Fully set up and activate the agent. Requires segmentType and signalProcessingType.

Response

201

application/json

Created

data · object

A Signal Agent (watch list) configuration.

Show child attributes