Lemlist: Connect Enrichment Provider

Save your own API key for an external enrichment provider in Lemlist so it can be used in waterfalls.

Tool ID: lemlist_connect_enrichment_provider

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'lemlist_connect_enrichment_provider',
  {
    "providerId": "provider_123",
    "apiKey": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute lemlist_connect_enrichment_provider --input '{
  "providerId": "provider_123",
  "apiKey": "example"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "data": {
      "id": "id_123",
      "displayName": "Example",
      "types": [
        "email"
      ],
      "source": "internal"
    }
  }
}

Use deepline describe lemlist_connect_enrichment_provider --json for the latest machine-readable contract.

Input reference

Saves your own API key for an external provider. The key is stored as-is and is NOT validated against the provider. calling it again replaces the key. The provider is connected for every enrichment type it supports. Once connected, the provider is added, disabled, to your existing custom waterfalls.

Name	Type	Required	Default	Details
`payload.providerId`	`string`	Yes	—	Id of an external provider, as listed by `GET /enrichments/providers`.
`payload.apiKey`	`string`	Yes	—	API key issued by the provider to your account. Minimum length: 1.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.data`	`object`	No	—	A data provider your team can place in a waterfall.
`result.data.data.id`	`string`	Yes	—	Stable identifier, to use as `providers[].id` in the waterfall endpoints.
`result.data.data.displayName`	`string`	Yes	—	Name shown in the lemlist app.
`result.data.data.types`	`array`	Yes	—	Enrichment types this provider supports.
`result.data.data.source`	`"internal" \| "external"`	Yes	—	`internal`: paid with lemlist credits, always available. `external`: called with your own API key, saved through the connection endpoint. Allowed: `internal`, `external`.
`result.data.data.connected`	`boolean`	No	—	Only on external providers: `true` once its API key is saved in lemlist. A waterfall can only enable a connected provider.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation