Skip to main content
Lemlist logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 65
  • Triggers: 0
  • Slug: LEMLIST
  • Version: 20261101_00

Tools

Slug: LEMLIST_ADD_CONTACTS_TO_LISTAdd existing Lemlist contacts to a static contact list.

Input Parameters

string
required
Static contact list ID in clt_* format.
array
required
One to 1,000 existing contact IDs in ctc_* format to add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_CREATE_COMPANY_NOTETool to create a note attached to a specific company. Use when you need to add annotations or notes to a company record for tracking purposes.

Input Parameters

string
required
The note content to be created for the company.
string
required
The unique identifier of the company to attach the note to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_DELETE_DELETE_SCHEDULETool to delete a specific schedule by scheduleId. Use when you need to remove a schedule permanently after confirming its ID.

Input Parameters

string
required
The unique ID of the schedule to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_DELETE_DELETE_UNSUBSCRIBE_EMAILTool to delete an email from the unsubscribed list. Use when restoring a subscriber who has opted back in and you need to remove them from the suppressed contacts.

Input Parameters

string
required
The email address to remove from the unsubscribed list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_DELETE_UNSUBSCRIBE_LEAD_FROM_CAMPAIGNTool to unsubscribe a lead from a campaign. Use when you need to stop further outreach by removing a lead from the specified campaign.

Input Parameters

string
required
The unique ID of the lead to unsubscribe
string
required
The unique ID of the campaign from which the lead will be unsubscribed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_ALL_WEBHOOKSRetrieve the team’s configured webhooks for synchronization or audit. An empty or non-JSON response is returned as an empty webhook list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_CAMPAIGN_BY_IDTool to retrieve a specific campaign by campaignId. Use when you need detailed campaign information by ID.

Input Parameters

string
required
Unique identifier of the campaign to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_CAMPAIGN_EXPORT_STARTTool to start an asynchronous export of all campaign statistics (CSV). Use when you need to initiate a CSV export for a given campaign and track its progress.

Input Parameters

string
required
Unique identifier of the campaign to export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_CAMPAIGN_EXPORT_STATUSTool to check the status of an asynchronous campaign export. Use after starting an export to poll until done or error.

Input Parameters

string
required
The ID of the export job returned from the start export endpoint.
string
required
The ID of the campaign whose export is being checked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_CAMPAIGN_SCHEDULESRetrieve all sending schedules associated with a campaign.

Input Parameters

string
required
Unique identifier of the campaign whose schedules to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_CAMPAIGN_SEQUENCESRetrieve a campaign’s sequences as a mapping keyed by sequence ID, including steps and branching conditions.

Input Parameters

string
required
Unique identifier of the campaign to fetch sequences for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_CAMPAIGN_STATSTool to retrieve performance statistics for a specific campaign within a date range. Use when you need campaign analytics including lead engagement, message delivery, and step-by-step performance metrics.

Input Parameters

string
required
End date for the statistics period in ISO 8601 format (e.g., 2026-02-14T23:59:59.999Z).
array
Filter by communication channels. Valid values include ‘email’, ‘linkedin’.
string
Filter statistics by specific user. Format: sendUserId|sendUserEmail
string
required
Start date for the statistics period in ISO 8601 format (e.g., 2025-01-01T00:00:00.000Z).
string
Filter by A/B test variant. Valid values: ‘A’ or ‘B’.
string
required
Unique identifier of the campaign to retrieve statistics for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_COMPANIES_SCHEMATool to retrieve the schema definition for companies in the people database. Use when you need to understand the structure, fields, and data types available for company records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_CONTACTRetrieve one Lemlist contact by contact ID or email address.

Input Parameters

string
required
Lemlist contact ID (ctc_*) or email address. CRM record IDs are not accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_CONTACT_MESSAGESRetrieve a paginated conversation history for a contact by ID. The request can also mark the conversation as read when a user ID is supplied.

Input Parameters

integer
Number of items to skip for pagination (default: 0)
integer
Maximum number of messages to retrieve
string
Identifier of the user viewing the conversation. Required if markAsRead is provided.
string
required
The unique identifier of the contact (format: ctc_*)
boolean
When true, marks the conversation as read (default: false). Requires userId to be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_DATABASE_FILTERSTool to retrieve available filters for searching the people and companies database. Use when you need to discover what search criteria are available before querying the database.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_EXPORT_CAMPAIGN_LEADSTool to export campaign leads with state filtering and choose between JSON or CSV output. Use when you need to download leads and their statuses for reporting or analysis.

Input Parameters

string
required
Filter to export only the specified leads’ last state. Specify one of the global states: imported, scanned, skipped, reviewed, contacted, hooked, attracted, warmed, interested, notInterested, emailsBounced, emailsUnsubscribed, meetingBooked, paused, failed; or detailed states: emailsSent, emailsOpened, emailsClicked, emailsReplied, emailsInterested, emailsNotInterested, emailsFailed, opportunitiesDone, aircallDone, aircallInterested, aircallNotInterested, apiDone, apiInterested, apiNotInterested, linkedinVisitDone, linkedinVisitFailed, linkedinInviteDone, linkedinInviteAccepted, linkedinInviteFailed, linkedinSent, linkedinOpened, linkedinReplied, linkedinInterested, linkedinNotInterested, linkedinSendFailed, manualInterested, manualNotInterested. Use ‘all’ to export all leads regardless of state.
string ("json" | "csv")
Output format for the export. Choose ‘json’ or ‘csv’.
string
required
The ID of the campaign to export leads from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_EXPORT_UNSUBSCRIBESTool to download a CSV file containing all unsubscribed email addresses. Use when you need to export the full unsubscribes list for analysis or archival.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_GET_UNSUBSCRIBE_EMAILTool to retrieve a single unsubscribed email record. Use when you need to verify if a specific email has opted out of campaigns before re-subscribing them.

Input Parameters

string
required
Email address of the unsubscribed user to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_LABELTool to retrieve information about a specific label by its ID. Use when you need details about an inbox label.

Input Parameters

string
required
Unique identifier of the label to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_LEAD_BY_IDRetrieve one Lemlist lead using its known lead identifier.

Input Parameters

string
required
Unique identifier of the lead to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_LEMWARM_SETTINGSRetrieve Lemwarm configuration and deliverability data for a mailbox.

Input Parameters

string
required
User mailbox ID from the Get User action, in usm_* format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_LIST_CAMPAIGNSTool to retrieve a list of campaigns for the team. Use when you need to discover campaign IDs, names, or statuses before performing operations like auditing or pausing campaigns.

Input Parameters

integer
Page number to retrieve (alternative to offset).
integer
Maximum number of campaigns to retrieve. Default: 100, Max: 100.
integer
Pagination offset - number of campaigns to skip.
string
Field to sort by. Currently only supports ‘createdAt’.
string ("running" | "draft" | "archived" | "ended" | "paused" | "errors")
Filter campaigns by status.
string ("asc" | "desc")
Sort order: ascending or descending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_LIST_TASKSRetrieve a page of pending tasks assigned to team members, with optional filters such as campaign or assignee. Completed tasks are automatically excluded from results.

Input Parameters

integer
Page number (0-indexed). Default: 0.
string
JSON array of filter objects as a string. Available filters: fullName, email, phone, linkedin, campaignId, campaignState, type, assignedTo, dueDate. Must be valid JSON array format (e.g., ’[]’ or ’[{“campaignId”:“abc123”}]’). Empty array returns all tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_LIST_TEAM_SENDERSTool to retrieve all team members and their associated campaigns. Use when you need to discover which team members are managing which campaigns or to understand campaign distribution across the team.

Input Parameters

string ("running" | "paused" | "draft" | "ended" | "archived" | "errors")
Valid campaign states for filtering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_LIST_WATCHLIST_SIGNALSTool to retrieve paginated watchlist signals with filtering and sorting. Use when you need to fetch signals from watchlists based on type, status, date range, or specific watchlist ID.

Input Parameters

integer
Page number to retrieve (cannot be used with offset).
string
Filter by signal type(s) such as ‘jobChange’, ‘companyIsHiring’, ‘companyRaisedFunds’, ‘newHire’, ‘companyEmployeeVisitedMyWebsite’, ‘linkedinProfile’, ‘linkedinTopic’.
integer
Number of signals to retrieve. Maximum value: 100.
integer
Number of records to skip (cannot be used with page).
string ("receivedAt" | "createdAt")
Fields available for sorting watchlist signals.
string
Filter by signal status(es) like ‘new’, ‘old’, ‘handled’, or ‘ignored’.
string ("asc" | "desc")
Sort order direction.
string
Filter signals by specific watchlist ID.
string
Filter signals received on or before this date (ISO date-time format).
string
Filter signals received on or after this date (ISO date-time format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_PEOPLE_SCHEMATool to retrieve the schema definition for people in the people database. Use when you need to understand available fields and their structure before querying or importing people data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_RETRIEVE_ACTIVITIESTool to fetch recent campaign activities. Use after authentication to retrieve activities filtered by campaignId, type, or limit.

Input Parameters

string
Filter activities by type, e.g., ‘paused’, ‘linkedinInviteAccepted’, ‘emailSent’.
integer
Maximum number of activities to retrieve. Default: 100, Max: 100.
string
Filter activities by lead ID.
integer
Number of records to skip for pagination.
boolean
Filter for first activity only.
string
Filter activities by contact ID.
string
Filter activities by specific campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_RETRIEVE_LEAD_BY_EMAILRetrieve a lead by email address, returning selected lead and campaign details.

Input Parameters

string
required
Email address of the lead to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_RETRIEVE_UNSUBSCRIBESRetrieve unsubscribe records across campaigns, with offset and limit pagination for syncing or auditing unsubscribed contacts.

Input Parameters

integer
Maximum number of unsubscribes to retrieve per request. Default: 100, Max: 100.
integer
Number of records to skip for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_TEAM_CREDITSRetrieve the team’s remaining credits and their breakdown. The credits endpoint returns an error for unpaid accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_TEAM_INFORetrieve information about your team, including member IDs, webhooks, and enabled features. Check the returned team identifier against the intended workspace before write operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_USERRetrieve a user by ID, including available LinkedIn settings and connected mailbox details.

Input Parameters

string
required
Unique identifier of the user to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_GET_USER_INFORetrieve available profile details for the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_LAUNCH_LEADLaunch a lead that is waiting for review in its Lemlist campaign.

Input Parameters

string
required
Lemlist lead ID to launch, in lea_* format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_LIST_COMPANIESTool to retrieve a paginated list of all companies in your CRM. Use when you need to discover companies, search by name, or fetch company details for further operations.

Input Parameters

integer
Page number to retrieve.
integer
Quantity of companies to retrieve per page. Default: 100, Max: 100.
string
Specify returned fields as comma-separated list. Omit to get all fields.
Search by company name (case insensitive).
string
Field to sort by. Currently only supports ‘createdAt’.
string
Sort direction: ‘desc’ for descending, other values for ascending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_LIST_COMPANY_NOTESRetrieve a page of notes associated with a specific company, with optional pagination and sorting. Use to view annotations, comments, or activities logged against a company record.

Input Parameters

integer
Page number for pagination.
integer
Number of notes to retrieve; default 100, max 100.
string
Sort field; currently supports ‘createdAt’.
string
required
Unique identifier of the company to retrieve notes for.
string
Sort direction (‘asc’ or ‘desc’); defaults to ascending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_LIST_CONTACTSSearch or filter one paginated contact page; not for batch ID lookup. Use LEMLIST_GET_CONTACT to retrieve a known contact by its ID or email.

Input Parameters

string
Exact contact email to match.
integer
Maximum contacts to return (1-500).
string
Static contact list ID (clt_*) whose contacts to return.
integer
Number of matching contacts to skip.
string
Text to search across contact name and other searchable fields.
string
Attached Lemlist company ID in cpn_* format. Mutually exclusive with the other company filters.
string
Website domain of the contact’s company. Mutually exclusive with the other company filters.
string ("synced" | "not_synced" | "error" | "searching" | "not_found" | "invalid_email" | "property_doesnt_exist" | "required_field_missing" | "unique_index_error_contact" | "contact_already_exists_with_name" | "contact_already_exists_with_linkedin_url" | "contact_already_exists_with_email" | "contact_blocked_by_company" | "contact_blocked_by_company_search" | "contact_blocked_by_company_without_name" | "contact_blocked_by_company_without_key" | "contact_blocked_by_company_already_synced")
CRM synchronization state to match. Requires an active connected CRM.
boolean
Return only contacts not enrolled in any campaign.
string
LinkedIn URL of the contact’s company. Mutually exclusive with the other company filters.
string
LinkedIn Sales Navigator URL of the contact’s company. Mutually exclusive with the other company filters.
boolean
True for contacts linked to a company; false for contacts without one. Mutually exclusive with the company identity filters.
string ("enrichment_duplicate_linkedin_url" | "enrichment_duplicate_linkedin_url_sales_nav" | "enrichment_duplicate_email" | "crm_sync_duplicate_linkedin_url" | "crm_sync_duplicate_linkedin_url_sales_nav" | "crm_sync_invalid_linkedin_url" | "crm_sync_invalid_url" | "crm_sync_invalid_email" | "crm_sync_invalid_phone" | "crm_sync_linkedin_url_not_contact" | "crm_sync_duplicate_contact_blocked" | "crm_sync_duplicate_company_blocked" | "crm_sync_company_data_rejected" | "crm_sync_unsub_state_protected" | "crm_sync_value_oscillating" | "crm_sync_owner_sync_loop" | "crm_sync_unmapped_user" | "crm_sync_value_incompatible" | "crm_sync_unknown_error")
Reason for a field value Lemlist refused to write.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_LIST_INBOX_CONVERSATIONSList a Lemlist user’s inbox conversations one page at a time.

Input Parameters

integer
One-indexed page number.
integer
Maximum conversations to return on the page.
string
required
Lemlist user ID whose conversations to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_LIST_LABELSTool to list all labels available to your team. Use when you need to retrieve the full list of labels for inbox organization or filtering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_PATCH_MARK_LEAD_AS_NOT_INTERESTED_IN_CAMPAIGNTool to mark a lead as not interested in a specific campaign. Use after confirming campaign and lead IDs to set status to not_interested.

Input Parameters

string
required
The unique identifier of the campaign.
string
required
The unique identifier of the lead or the lead’s email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_PATCH_UPDATE_CAMPAIGNTool to update settings of a campaign. Use after fetching or creating a campaign to adjust name, stop-on behaviors, and other campaign flags.

Input Parameters

string
New name for the campaign.
string
required
Identifier of the campaign to update.
boolean
Enable or disable sharing of the sequence.
boolean
Automatically determine lead interest.
boolean
Disable email open tracking.
boolean
Disable email click tracking.
boolean
Disable reply tracking.
Whether the campaign should stop on any link click.
boolean
Mark opportunity when clicked.
boolean
Mark opportunity when replied.
boolean
Whether the campaign should stop when an email is replied to.
boolean
Whether the campaign should stop when a meeting is booked.
boolean
Pause leads when they show interest.
URL filter for stopping on link click; set to null to unset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_PATCH_UPDATE_SCHEDULETool to update an existing schedule with new parameters. Use after retrieving schedule details to adjust days, time window, and limits.

Input Parameters

array
List of weekdays when sends are allowed. e.g., [‘monday’,‘tuesday’,‘wednesday’].
string
New name for the schedule.
boolean
Whether the schedule is active (true) or paused (false).
string
Daily send window end time in HH:mm format. e.g., ‘17:30’.
string
IANA timezone for the schedule. e.g., ‘Europe/Paris’.
integer
Maximum number of sends allowed per day.
string
Daily send window start time in HH:mm format. e.g., ‘09:00’.
string
required
Identifier of the schedule to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_PATCH_UPDATE_SEQUENCE_STEPTool to update an existing step in a sequence (edit subject/message/delay/etc.) by sequenceId and stepId. Use after retrieving sequences to modify step content or timing.

Input Parameters

string
Valid HTTP/HTTPS URL for API call. Only applicable for ‘api’ type steps.
string
required
Type of the step (required but cannot be changed; must match existing step type). Valid types: ‘email’, ‘linkedinInvite’, ‘linkedinView’, ‘linkedinSend’, ‘manual’, ‘phone’, ‘whatsappMessage’, ‘api’, ‘conditional’, ‘sendToAnotherCampaign’.
integer
Delay in hours before step execution. Not applicable for ‘sendToAnotherCampaign’ type.
string
Manual task label. Only applicable for ‘manual’ type steps.
string ("GET" | "POST" | "PUT" | "DELETE" | "PATCH")
HTTP verb for API call. Only applicable for ‘api’ type steps.
string
required
Unique identifier of the step to update.
string
Message content. Applicable for ‘email’, ‘manual’, ‘phone’, LinkedIn types, and ‘whatsappMessage’ steps.
string
Email subject line. Only applicable for ‘email’ type steps.
string ("within" | "waitUntil")
Timing logic for conditional steps. Only applicable for ‘conditional’ type steps.
string
Fallback message. Only applicable for ‘linkedinSend’ type steps.
string
Destination campaign ID. Only applicable for ‘sendToAnotherCampaign’ type steps.
string
required
Unique identifier of the sequence containing the step.
string
Behavior trigger identifier. Only applicable for ‘conditional’ type steps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_ADD_STEP_TO_SEQUENCETool to add a new step (email, LinkedIn, conditional, etc.) to an existing sequence. Use when building or editing campaign sequences to add outreach steps.

Input Parameters

string
URL of the API endpoint to call. Required for api steps. Must start with http:// or https://
string ("email" | "manual" | "phone" | "api" | "linkedinVisit" | "linkedinInvite" | "linkedinSend" | "sendToAnotherCampaign" | "conditional" | "whatsappMessage")
required
The type of step to create. Must be one of: email, manual, phone, api, linkedinVisit, linkedinInvite, linkedinSend, sendToAnotherCampaign, conditional, whatsappMessage
integer
Delay in seconds before the step executes. Defaults to 0 for the first step, 1 for subsequent steps. For conditional steps with delayType other than ‘within’, delay is not required
integer
Position in the sequence (must be >= -1). If omitted or exceeds the step count, the step is appended to the end
string
Title or label for manual steps. Required for manual steps
string ("GET" | "POST" | "PUT" | "DELETE" | "PATCH")
HTTP method for API steps. Required for api steps
string
Content for email, LinkedIn, manual, phone, or WhatsApp steps. Required for steps that send messages
string
Email subject line. Required for email steps
string ("within" | "waitUntil")
Delay type for conditional steps. Must be ‘within’ or ‘waitUntil’. For conditional steps with delayType other than ‘within’, the delay field is not required
string
Alternate message for linkedinSend steps
string
Target campaign ID for sendToAnotherCampaign steps. Required for sendToAnotherCampaign steps
string
required
The unique identifier of the sequence to add the step to
string ("emailsOpened" | "emailsClicked" | "emailsUnsubscribed" | "meetingBooked" | "linkedinInviteAccepted" | "hasWhatsappAccount")
Condition type for conditional steps. Must be one of: emailsOpened, emailsClicked, emailsUnsubscribed, meetingBooked, linkedinInviteAccepted, hasWhatsappAccount

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_ADD_UNSUBSCRIBE_EMAIL_DOMAINTool to add an email or domain to the unsubscribed list. Use when you need to globally block sending to a specific recipient or domain.

Input Parameters

string
required
Email address or domain to add to the unsubscribed list. Domain entries must start with ’@’, e.g. ‘@example.com’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_ADD_VARIABLES_TO_LEADTool to add one or more variables to a lead. Use when you need to enrich a lead with custom data after its creation or retrieval.

Input Parameters

string
required
Unique identifier of the lead to which the variables will be added.
string
required
Namespace for these variables; must match your company name in Lemlist.
object
required
Mapping of variable names to values. Keys must be unique and not override existing variables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_ASSOCIATE_SCHEDULE_WITH_CAMPAIGNTool to associate a schedule with a campaign. Use after confirming both campaignId and scheduleId to bind a schedule to its campaign.

Input Parameters

string
required
ID of the campaign to which the schedule will be associated
string
required
ID of the schedule to associate with the campaign

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_CREATE_CAMPAIGNTool to create a new campaign. Use after confirming the team ID. Returns campaign, sequence, and schedule IDs nested under a data key (e.g., result['data']['campaignId']).

Input Parameters

string
required
The name of the campaign to create
string
required
The ID of the team under which the campaign will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_CREATE_LABELTool to create a new label for inbox conversations. Use when you need to organize inbox messages with custom labels.

Input Parameters

string
required
Name of the label to create. Must be unique within the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_CREATE_LEAD_IN_CAMPAIGNTool to create a lead and add it to a specific campaign. Use when you need to enroll a new lead into an outreach campaign. Supports optional deduplication and enrichment features.

Input Parameters

string
required
Email address of the lead (required for lead creation).
string
Contact phone number for the lead.
string
Lead’s professional role or job title.
string
Last name of the lead.
string
IANA format timezone for the lead (e.g., Europe/Paris, America/New_York).
boolean
If true, attempts to find and verify the lead’s email address.
boolean
If true, attempts to find the lead’s phone number.
string
First name of the lead.
string
required
Unique identifier of the campaign to add the lead to.
string
Personalized message or icebreaker text for the lead.
string
Name of the lead’s organization.
boolean
If true, checks if email exists in other campaigns and skips insertion if found (prevents duplicate leads).
string
URL to the lead’s LinkedIn profile.
boolean
If true, validates the existing email using debounce service.
string
User ID or email of the contact owner responsible for this lead.
string
Domain of the lead’s company website.
boolean
If true, executes LinkedIn enrichment to enhance lead data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_CREATE_SCHEDULECreate a team schedule with custom active times or delays for outreach operations. Returns the created schedule and its identifier for association with a campaign.

Input Parameters

string
Optional end time in HH:mm format. Defaults to ‘18:00’.
string
Optional name for the schedule. Defaults to ‘Default schedule’.
string
Optional start time in HH:mm format. Defaults to ‘09:00’.
string
Optional timezone for the schedule (IANA timezone identifier). Defaults to ‘Europe/Paris’.
array
Optional list of active weekdays (1=Monday .. 7=Sunday). Defaults to [1,2,3,4,5].
integer
Optional delay in seconds between operations. Defaults to 1200 seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_CREATE_TASKCreate a task (opportunity) associated with a contact, company, or lead to track outreach follow-ups or action items. Supported task types are email, manual, phone, and LinkedIn.

Input Parameters

string ("email" | "manual" | "phone" | "linkedin")
required
Task type - must be one of: email, manual, phone, or linkedin.
string
Task title; defaults to empty string if not provided.
string
required
Due date timestamp in ISO 8601 format (e.g., 2026-03-15T10:00:00.000Z).
string
Task description/message; defaults to empty string if not provided.
string
Priority level - empty string, 0, 1, or 2; defaults to empty string if not provided.
string
required
The ID of the contact, company, or lead associated with the task.
string
required
The user ID of the team member assigned to the task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_IGNORE_TASKSTool to mark one or more tasks as ignored in Lemlist. Use when you want to dismiss tasks without completing them.

Input Parameters

array
required
Array of task IDs to ignore (e.g., opp_ouYzdLYGs4RcrHTfm)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_MARK_LEAD_AS_INTERESTEDTool to mark a lead as interested in all campaigns. Use when a lead responds positively and you want to advance or personalize your outreach.

Input Parameters

string
required
Email address of the lead to mark as interested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_MARK_LEAD_AS_INTERESTED_IN_CAMPAIGNTool to mark a lead as interested in a specific campaign. Use after confirming the lead’s positive engagement in that campaign.

Input Parameters

string
required
Email address of the lead to mark as interested.
string
required
Unique identifier of the campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_MARK_LEAD_AS_NOT_INTERESTEDTool to mark a lead as not interested in all campaigns. Use when a lead explicitly declines outreach and should be paused across campaigns.

Input Parameters

string
required
Email address or lead ID (‘lea_…’) to mark as not interested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_PAUSE_CAMPAIGNTool to pause a running campaign. Use after confirming you have the correct campaign ID and that the campaign is currently running.

Input Parameters

string
required
ID of the campaign to pause

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_POST_PAUSE_LEADTool to pause a lead in all campaigns or a specific campaign. Use when you want to temporarily halt outreach to a lead.

Input Parameters

string
ID of the campaign to pause the lead in. If omitted, pauses in all campaigns.
string
required
Email address of the lead or the lead’s Lemlist ID (e.g., lea_xxx)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_SEARCH_COMPANIES_DATABASETool to search the companies database using filters, keywords, and pagination. Use when you need to find companies based on criteria like industry, size, or keywords. Returns a paginated list of companies matching the specified filters.

Input Parameters

integer
Page number for pagination (1-indexed). Defaults to 1.
integer
Number of results per page. Maximum 100. Defaults to 25.
string
Free-text query to search across common company fields like name, domain, and keywords.
array
Array of filter objects to narrow search results by criteria like keywords, industry, or company size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_SEARCH_PEOPLE_DATABASETool to search the Lemlist people database using filters, keywords, and pagination. Use when you need to find prospects based on criteria like location, job title, seniority, or company. Supports free-text search and structured filtering.

Input Parameters

integer
Page number for pagination (1-indexed). Minimum value is 1.
integer
Number of results per page. Must be between 1 and 100.
string
Free-text search query across common fields (name, title, company, location). Use for keyword-based filtering.
array
required
Array of filter objects to narrow search results. Each filter must include filterId, ‘in’ array, and ‘out’ array (can be empty).
array
Array of field names to omit from the response. Use to reduce payload size when certain fields are not needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_SEND_INBOX_EMAILSend a standalone inbox email or reply in an existing Lemlist thread.

Input Parameters

array
CC addresses. On a reply, omit to inherit the thread CC or pass an empty list for no CC.
string
Lead ID whose contact should receive the email. Provide this, contactId, or both.
string
required
Email message as HTML.
string
Subject for a standalone email. Omit when replying in a thread.
string
Contact ID to email. Provide this, leadId, or both.
string
required
Lemlist user ID of the sender.
string
required
Email address of the sender.
string
Email activity ID in act_* format, or ‘latest’, to reply within a thread.
string
required
Connected sender mailbox ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_UPDATE_CAMPAIGN_LEADUpdate a campaign lead. At least one writable field is required; changing companyName also updates the linked shared company record.

Input Parameters

string
required
Identifier of the lead to update.
string
New job title for the lead.
string
New last name for the lead.
string
New first name for the lead.
string
required
Identifier of the campaign containing the lead.
string
New name for the company linked to the lead. This updates the shared company record.
string ("overwrite" | "overwriteIgnoreEmpty" | "fillEmptyOnly")
How existing values are handled: overwrite, ignore empty inputs, or fill only empty fields.
string ("email" | "linkedIn")
Preferred method for contacting the lead: email or LinkedIn.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_UPDATE_TASKTool to update an existing task including assignment, scheduling, and status. Use when modifying task details such as title, priority, due date, or completion status.

Input Parameters

string
required
The unique identifier of the task to update.
boolean
Mark task as completed (true) or incomplete (false).
string
Updated task title.
string
Updated due date in ISO 8601 format.
string
Updated task message/description.
string ("" | "0" | "1" | "2")
Priority levels for tasks.
string
The ID of the team member to assign the task to (userId).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEMLIST_UPSERT_CONTACTCreate a standalone contact or reconcile an existing Lemlist contact.

Input Parameters

string
Closed-beta record ID in the connected CRM to link. Requires the CRM ID remap beta and an admin API key. Pass numeric CRM IDs as strings to preserve identifiers longer than JavaScript’s safe integer range.
string
Primary email and upsert identifier.
string
Contact phone number.
string
Contact skills.
string
Origin of the contact record. Set only on creation and defaults to api.
string
URL of the contact’s profile picture.
string
Contact summary or bio.
string
Contact tagline.
string
Contact industry.
string
Contact job title.
string
Contact last name.
string
Contact location.
string
Contact timezone.
string
ID of an existing Lemlist company to link; takes priority over companyDomain and companyLinkedinUrl.
string
Existing contact ID to update directly.
string
Contact first name.
string
Contact languages.
string
LinkedIn profile URL and alternative upsert identifier.
string
Owner user ID or team-member email.
object
Additional registered Lemlist CRM fields to write. Explicit standard field names are ignored here; use their dedicated parameters instead.
string
Domain of an existing Lemlist company to link, used when companyId is not provided.
string
Contact job description. When a company is linked, Lemlist saves this as part of the job data.
string ("overwriteIgnoreEmpty" | "overwrite" | "fillEmptyOnly")
How sent values affect fields already stored on a matching contact.
array
Additional valid email addresses for the contact.
string
Seniority of the person from the People Database.
string
LinkedIn URL of an existing Lemlist company to link, used when companyId and companyDomain are not provided.
string
Department of the person from the People Database.
string
Sales Navigator URL and alternative upsert identifier.
string
LinkedIn connection count from the People Database, represented as a string; 500 usually means 500 or more.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not