Skip to main content
POST
Push external signals
Send contact for an externalSignalContact agent, or company for an externalSignalCompany agent — the agent’s type decides which block is required. Create the external-signal agent from the lemlist app first (Signal Agents → external signal); these agent types are set up in the app, not through the Create Signal Agent endpoint. External signals are free (creditsConsumed is always 0) and capped by the agent’s daily limit (default 50/day); over the cap, or when no matching entity is found, the signal is returned with status: "ignored".

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

watchListId
string
required

Id of the Signal Agent to push the signal to. Must be an externalSignalContact or externalSignalCompany agent.

Body

application/json
contact
object

The contact the signal is about. Required for externalSignalContact agents; ignored otherwise.

company
object

The company the signal is about. Required for externalSignalCompany agents; ignored otherwise.

customFields
object

Optional key/value metadata stored on the signal. Max 20 keys; all values must be strings.

Example:

Response

Signal processed or ignored. status is processed when a signal was created, or ignored when no matching entity was found or the agent's daily limit was reached. External signals are free, so creditsConsumed is always 0.

status
enum<string>

processed when a signal was created, ignored otherwise

Available options:
processed,
ignored
signalId
string

Id of the created signal. Present when status is processed.

Example:

"wls_ExAmPlE1234567890a"

reason
enum<string>

Why the signal was ignored. Present when status is ignored.

Available options:
no_entity_match,
daily_limit_reached
creditsConsumed
integer

Always 0 - external signals are free.

Example:

0

entity
object

The matched entity. Present when status is processed.