> ## Documentation Index
> Fetch the complete documentation index at: https://developer.lemlist.com/llms.txt
> Use this file to discover all available pages before exploring further.
> Links a Signal Agent to a campaign as its signal trigger.
# Add Signal Agent Trigger
This endpoint is in beta: it requires the `campaignSignalTrigger` beta on your team (`403 BETA_NOT_ENABLED` otherwise).
Once linked, every new signal of the Signal Agent pushes its contact into the
campaign as a lead. Signals detected before the link are not backfilled.
The link is additive: linking a second Signal Agent adds it next to the first,
and `watchListIds` in the response lists every agent linked to the campaign.
The link uses the default import options — deduplicate on, duplicates handled
manually, no backfill. Adjust them in the campaign editor in the lemlist app.
A campaign created through the API or the MCP has no creation mode yet: the
first link makes it a signal-based campaign, so the trigger shows in its
sequence editor. A campaign set up as manual in the lemlist app cannot take a
signal trigger (`409`): create a signal-based campaign instead.
A draft Signal Agent can be linked, but the campaign cannot be launched from
the lemlist app until at least one linked agent is active.
A company-level Signal Agent without a persona sources no contact, so nothing
reaches the campaign. Set its `personaId` first — see
[List personas](/api-reference/endpoints/people-database/list-personas).
To create a Signal Agent and link it in one call, pass `campaignId` to
[Create Signal Agent](/api-reference/endpoints/watch-list/create-watch-list).
## OpenAPI
````yaml post /campaigns/{campaignId}/triggers/watch-lists
openapi: 3.0.0
info:
title: lemlist API
version: 1.0.0
description: >-
Welcome to the lemlist Developer Documentation.
lemlist is very customizable and open. You'll find on this page all the API
and integration you can do with lemlist.
# Rate Limit
lemlist's API rate limits requests in order to prevent abuse and overload of
our services.
Rate limits are applied on all routes and per API key performing the
request.
The rate limits are **20** requests per **2** seconds.
The response provides any information you may need about it:
| Header | Description |
| --- | --- |
| Retry-After | The number of seconds in which you can retry |
| X-RateLimit-Limit | The maximum requests in that time |
| X-RateLimit-Remaining | The number of remaining requests you can make |
| X-RateLimit-Reset | The date when the rate limit will reset |
_Example of values for the rate limit headers_
``` json
{
"Retry-After": 2,
"X-RateLimit-Limit": 20,
"X-RateLimit-Remaining": 7,
"X-RateLimit-Reset" : "Tue Feb 16 2021 09:02:42 GMT+0100 (Central European Standard Time)"
}
```
# Definitions
## Team
A team is the entity of lemlist that can handle users and billing.
## Credits
Credits are the coins a team uses to enrich emails, LinkedIn URLs, etc. via
the enrich route. Each enrichment feature needs a certain amount of credits
to run.
## User
You use a user account to connect to lemlist and send messages via the
connected emails or LinkedIn account.
## Campaign
A campaign is the entity to automate outreach. A campaign has multiple
sequences composed of steps.
## Lead
A lead is a person that you try to contact via a campaign.
## Activity
An activity is the history of all the steps.
## Unsubscribe
An unsubscribe occurs when a person decides they don't want to receive
emails from you anymore.
# Authentication
All API routes use the dedicated subdomain `api.lemlist.com`.
lemlist uses API keys to allow access to the API. You can get your lemlist
API key at our [integration
page](https://app.lemlist.com/settings/integrations).
You need to add the `Authorization` header using the `Basic` authentication
type. `login:password` **where the login is always empty and the password is
the API key**.
⚠️ **Don't forget to add the semicolon (**`:`**) before your API key in curl
command.**
> To authorize, use this code:
``` shell
curl https://api.lemlist.com/api/team \
--user ":YourApiKey"
```
**Make sure to replace** **`YourApiKey`** **with your API key.**
# Give feedback
If you want to report a bug, ask for data, or share with us a use case,
please fill this [form](https://lemlist.typeform.com/to/mfVlkyGf). It will
help us centralize your needs!
servers:
- url: https://api.lemlist.com/api
security:
- basicAuth: []
tags:
- name: Enrichment Providers
description: >-
The data providers lemlist can call to find an email or a phone.
Internal providers are paid with lemlist credits and always available.
External providers run on your own account: connect one by saving its API
key, and it becomes available to your waterfalls. `GET
/enrichments/providers` is the catalog of provider ids accepted by the
waterfall endpoints.
- name: Enrichment Waterfalls
description: >-
Control which data providers lemlist calls when enriching a contact, and
in which order.
A waterfall is an ordered list of providers for one enrichment `type`
(`email` or `phone`). Providers are tried one after the other until one
returns a result.
Every team has exactly one default waterfall per type (`isDefault: true`).
While its `editor` is `lemlist` it follows the lemlist behaviour:
providers you connected with your own API key are tried first, then
internal providers in a random order. Once a team member edits its
provider list, `editor` becomes that user's id and the list is followed as
is; resetting it hands it back to `lemlist`.
Custom waterfalls (`isDefault: false`) carry `conditions` on the contact
being enriched, keyed by contact property; every key present must match.
When a contact is enriched, lemlist runs a single waterfall: the custom
waterfall of the requested type whose conditions match the contact, or the
default waterfall when none does. If several match, the one with the most
condition keys wins, then the most recently updated. Only that waterfall
runs; when it finds nothing, the enrichment ends without falling back to
another one.
paths:
/campaigns/{campaignId}/triggers/watch-lists:
post:
tags:
- Signal Agents
summary: Add Signal Agent Trigger
description: >-
Links a Signal Agent to a campaign as its signal trigger. Every new
signal of the agent then pushes its contact into the campaign as a lead.
Requires the `campaignSignalTrigger` beta.
parameters:
- name: campaignId
in: path
required: true
description: The unique identifier of the campaign
example: cam_ExAmPlE4k8Qz2Wn7R
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- watchListId
properties:
watchListId:
type: string
description: Id of the Signal Agent (wat_xxx) to link to the campaign.
example: wat_ExAmPlE9Hd3Vx6Tp1
example:
watchListId: wat_ExAmPlE9Hd3Vx6Tp1
responses:
'200':
description: >-
The Signal Agent is linked. `data` is the campaign's signal-trigger
configuration, with every linked agent in `watchListIds`.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
watchListIds:
type: array
items:
type: string
description: >-
Every Signal Agent linked to the campaign as a signal
trigger.
importFromExistingSignals:
type: boolean
description: >-
Whether signals detected before the link are
backfilled into the campaign. `false` on a link made
through the API; change it in the campaign editor.
deduplicate:
type: boolean
description: >-
Whether a contact already in the campaign is skipped
instead of being added again.
duplicateProcessingType:
type: string
enum:
- manual
- create_opportunity
description: How a duplicate contact is handled.
example:
data:
watchListIds:
- wat_ExAmPlE9Hd3Vx6Tp1
importFromExistingSignals: false
deduplicate: true
duplicateProcessingType: manual
'400':
description: >-
`ROUTE_BAD_REQUEST` - `campaignId` is malformed, or `watchListId` is
missing, not a string, or malformed.
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
type: string
examples:
badRequest:
value:
error: Route bad request
code: ROUTE_BAD_REQUEST
'401':
description: '`ROUTE_UNAUTHORIZED` - invalid or missing API key'
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
type: string
examples:
unauthorized:
value:
error: Route unauthorized
code: ROUTE_UNAUTHORIZED
'403':
description: >-
`BETA_NOT_ENABLED` - the `campaignSignalTrigger` beta is not enabled
for this team
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
type: string
examples:
betaNotEnabled:
value:
error: Beta is not enabled
code: BETA_NOT_ENABLED
'404':
description: >-
`WATCH_LIST_IMPORT_LEADS_CAMPAIGN_NOT_FOUND` or
`WATCH_LIST_NOT_FOUND` - the campaign or the Signal Agent does not
exist in this workspace.
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
type: string
examples:
campaignNotFound:
value:
error: Campaign not found
code: WATCH_LIST_IMPORT_LEADS_CAMPAIGN_NOT_FOUND
watchListNotFound:
value:
error: Watch list not found
code: WATCH_LIST_NOT_FOUND
'405':
description: '`ROUTE_BAD_METHOD` - method not allowed'
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
type: string
examples:
badMethod:
value:
error: Route bad method
code: ROUTE_BAD_METHOD
'409':
description: >-
`WATCH_LIST_CAMPAIGN_IS_MANUAL` - the campaign was set up as a
manual campaign in the lemlist app and cannot take a signal trigger.
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
type: string
examples:
campaignIsManual:
value:
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
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
````