1. Overview
Lemlist is a powerful email outreach and sales automation platform designed for personalized cold email campaigns. It provides comprehensive lead management, email tracking, campaign analytics, and data enrichment features to help sales teams scale their outreach efforts.
With the GoInsight Lemlist node, you can seamlessly integrate email marketing automation into your workflows. You can manage the complete lifecycle of campaigns, leads, and data enrichment, including:
- Campaign Management: Retrieve campaign lists and view detailed campaign statistics.
- Lead Operations: Create, retrieve, delete leads, and manage subscription status.
- Data Enrichment: Enrich lead and person information to obtain verified emails, phone numbers, and LinkedIn data.
- Team Management: Retrieve team information and credit balance.
- Unsubscribe Management: Manage the global unsubscribe list.
2. Prerequisites
Before using this node, you need to have a valid Lemlist account. You may need administrator or specific permissions to create and manage API credentials.
3. Credentials
For a detailed guide on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.
Lemlist uses API Key authentication. You can generate your API Key in your Lemlist account settings.
4. Supported Operations
Summary
This node allows you to perform operations related to activities, campaigns, leads, enrichment, team, and unsubscribe management in your Lemlist account.
| Resource | Operation | Description |
|---|---|---|
| Activity | Get Many Activities | Retrieve multiple activity records with pagination and filtering options. |
| Campaign | Get Many Campaigns | Retrieve multiple campaigns with pagination and sorting options. |
| Campaign | Get Campaign Stats | Retrieve detailed statistics for a specific campaign. |
| Lead | Create Lead | Create a new lead in a campaign. |
| Lead | Get Lead | Retrieve lead information by email address. |
| Lead | Delete Lead | Delete a lead from a campaign. |
| Lead | Unsubscribe Lead | Unsubscribe a lead from a campaign. |
| Enrichment | Enrich Lead | Enrich lead information using lead ID. |
| Enrichment | Enrich Person | Enrich person data using email, LinkedIn URL, or other identifiers. |
| Enrichment | Get Enrichment | Retrieve the results of a completed enrichment task. |
| Team | Get Team | Retrieve team information. |
| Team | Get Team Credits | Retrieve team credit balance and usage information. |
| Unsubscribe | Add Email to Unsubscribe List | Add an email to the global unsubscribe list. |
| Unsubscribe | Delete Email from Unsubscribe List | Remove an email from the global unsubscribe list. |
| Unsubscribe | Get Many Unsubscribed Emails | Retrieve the list of unsubscribed emails. |
Operation Details
Get Many Activities
Retrieve multiple activity records from Lemlist with pagination and filtering options. Supports filtering by activity type, campaign ID, lead ID, and first activity flag.
Options:
- Limit: Number of results to return (max 100, default: 100)
- Offset: Offset for pagination (default: 0)
- Type: Filter by activity type (e.g., paused, emailOpened, emailClicked)
- CampaignId: Filter by campaign ID
- IsFirst: Filter for first activity
- LeadId: Filter by lead ID
Output:
- Activities (object-array): List of activity records containing activity details
- StatusCode (number): Operation result code (-1: parameter validation error, 200: success, other: HTTP status code)
- ErrorMessage (string): Error description (empty on success)
Get Many Campaigns
Retrieve multiple campaigns from Lemlist with pagination, sorting, and status filtering options.
Options:
- Limit: Number of results to return (max 100, default: 100)
- Offset: Offset for pagination (default: 0)
- Page: Page number to retrieve
- SortBy: Sort field (currently only 'createdAt' is supported)
- SortOrder: Sort direction ('asc' or 'desc')
- Status: Campaign status filter (running, draft, archived, ended, paused, errors)
Output:
- Campaigns (object-array): List of campaign objects containing campaign details and statistics
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Get Campaign Stats
Retrieve detailed statistics for a specific Lemlist campaign within a date range. Supports filtering by send user, A/B test version, and communication channels.
Input Parameters:
- CampaignId: ID of the campaign to retrieve statistics for
- StartDate: Start date in ISO 8601 format (e.g., 2024-01-01T00:00:00Z)
- EndDate: End date in ISO 8601 format (e.g., 2024-12-31T23:59:59Z)
Options:
- SendUser: Filter by send user (format: sendUserId|sendUserEmail)
- ABSelected: A/B test version filter (A or B)
- Channels: Channel filter, JSON array string (e.g., ["email", "linkedin"])
Output:
- Stats (object): Campaign statistics object containing detailed metrics
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Create Lead
Create a new lead in a Lemlist campaign with contact information including email, name, LinkedIn URL, and company details.
Input Parameters:
- CampaignId: ID of the campaign to add the lead to
- Email: Email address of the lead
Options:
- FirstName: First name of the lead
- LastName: Last name of the lead
- LinkedinUrl: LinkedIn profile URL
- CompanyName: Company name
Output:
- Lead (object): Created lead information containing all lead details
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Get Lead
Retrieve detailed information about a specific lead from Lemlist using their email address.
Input Parameters:
- Email: Email address of the lead to retrieve
Output:
- Lead (object): Lead information containing all available details and campaign associations
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Delete Lead
Delete a lead from a Lemlist campaign. Supports optional force delete to permanently remove the lead.
Input Parameters:
- CampaignId: ID of the campaign containing the lead
- LeadId: ID of the lead to delete
Options:
- ForceDelete: Force delete the lead permanently (default: false)
Output:
- Result (object): Deletion operation result containing success status and message
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Unsubscribe Lead
Unsubscribe a lead from a Lemlist campaign, preventing them from receiving further emails from that campaign.
Input Parameters:
- CampaignId: ID of the campaign to unsubscribe the lead from
- Email: Email address of the lead to unsubscribe
Output:
- Result (object): Unsubscribe operation result containing success status and message
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Enrich Lead
Enrich a lead's information in Lemlist using their lead ID. Supports finding verified email, LinkedIn enrichment, and phone number lookup.
Input Parameters:
- LeadId: Unique lead ID to enrich
Options:
- FindEmail: Search email address in another campaign (default: false)
- VerifyEmail: Find verified email (default: false)
- LinkedinEnrichment: Run LinkedIn enrichment (default: false)
- FindPhone: Find phone number (default: false)
- WebhookUrl: Webhook URL for enrichment events
Output:
- Enrichment (object): Enrichment result containing enriched lead information
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Enrich Person
Enrich person data using email, LinkedIn URL, name, or company information. Supports finding verified email, LinkedIn enrichment, and phone number lookup.
Options:
- Email: Email address
- LinkedinUrl: LinkedIn URL
- FirstName: First name
- LastName: Last name
- CompanyDomain: Company domain
- CompanyName: Company name
- FindEmail: Find verified email (default: false)
- VerifyEmail: Verify existing email (default: false)
- LinkedinEnrichment: Run LinkedIn enrichment (default: false)
- FindPhone: Find phone number (default: false)
- WebhookUrl: Webhook URL for enrichment events
Output:
- Enrichment (object): Enrichment result containing enriched person information
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Get Enrichment
Retrieve the results of a previously completed enrichment task using the enrichment ID.
Input Parameters:
- EnrichmentId: ID of the enrichment task to retrieve
Output:
- Enrichment (object): Enrichment data object containing complete enrichment results and metadata
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Get Team
Retrieve information about your Lemlist team, including team members, settings, and subscription details.
Output:
- Team (object): Team information containing complete team details, members, and settings
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Get Team Credits
Retrieve your Lemlist team's credit balance and usage information for enrichment features.
Output:
- Credits (object): Credit information containing balance, usage details, and breakdown by feature
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Add Email to Unsubscribe List
Add an email address to the global unsubscribe list, preventing it from receiving any emails from all campaigns.
Input Parameters:
- Email: Email address to add to unsubscribe list
Output:
- Result (object): Operation result containing success status and email details
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Delete Email from Unsubscribe List
Remove an email address from the global unsubscribe list, allowing it to receive emails from campaigns again.
Input Parameters:
- Email: Email address to remove from unsubscribe list
Output:
- Result (object): Operation result containing success status and email details
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
Get Many Unsubscribed Emails
Retrieve a list of all email addresses in the global unsubscribe list with pagination support.
Options:
- Limit: Number of results to return (default: 100)
- Offset: Offset for pagination (default: 0)
Output:
- Emails (object-array): List of unsubscribed email addresses with metadata
- StatusCode (number): Operation result code
- ErrorMessage (string): Error description (empty on success)
5. Example Usage
This section will guide you through creating a simple workflow to create a new lead in your Lemlist campaign.
The workflow will consist of three nodes: Start -> Lemlist: Create Lead -> Answer.
- Add the Lemlist Node
- In the workflow canvas, click the "+" icon to add a new node.
- In the pop-up panel, select the "Tools" tab.
- Find and select "Lemlist" from the list of tools.
- From the list of supported operations for Lemlist, click on "Create Lead" to add the node to your canvas.
- Configure the Node
- Click on the newly added "Create Lead" node to open its configuration panel on the right.
- Credentials Configuration: At the top of the panel, find the credentials field. Click the dropdown menu and select your pre-configured Lemlist credential.
- Parameter Configuration: Fill in the required parameters to create your lead.
- CampaignId: Enter the ID of the campaign where you want to add the lead, for example, cam_abc123.
- Email: Enter the lead's email address, for example, john.doe@example.com.
- FirstName (Optional): Enter the lead's first name, for example, John.
- LastName (Optional): Enter the lead's last name, for example, Doe.
- CompanyName (Optional): Enter the company name, for example, Acme Corp.
- Run and Verify
- Once all required parameters are correctly filled, any error indicators on the workflow canvas will disappear.
- Click the "Run" button in the top-right corner of the canvas to execute the workflow.
- After a successful execution, you can click the logs icon in the top-right corner to view the detailed inputs and outputs of the node, verifying that the lead was created successfully.
After completing these steps, your workflow is fully configured. When executed, it will create a new lead in your Lemlist campaign.
6. FAQs
Q: Why am I getting a 401 Unauthorized error?
A: This typically indicates an issue with your API credentials. Please check the following:
- API Key: Ensure your API Key is correct and has not expired.
- Account Status: Verify that your account has the necessary permissions.
Q: How do I find my Campaign ID?
A: You can obtain your Campaign ID by:
- Using the Get Many Campaigns operation to retrieve all campaign lists.
- In the Lemlist web interface, the Campaign ID is included in the campaign URL.
Q: Do data enrichment features require additional fees?
A: Yes, Lemlist's data enrichment features consume credits. You can use the Get Team Credits operation to check your current credit balance.
Q: What's the difference between deleting a lead and unsubscribing a lead?
A:
- Delete Lead: Completely removes the lead from the campaign.
- Unsubscribe Lead: Marks the lead as unsubscribed, preventing them from receiving further emails.
Q: How do I handle paginated data?
A: For operations that return lists (such as Get Many Activities), you can:
- Use the Limit parameter to control the number of results per page.
- Use the Offset parameter for pagination.
- Call multiple times in a loop to retrieve all data.
7. Official Documentation
For more in-depth information about the capabilities and technical details of the API, please refer to the Lemlist Official API Documentation.
Leave a Reply.