Skip to content
Changelog

Report a bug

Lemlist integration: operations for AI agents

Lemlist connects to Type.com as an integration. This page lists the 211 operations documented for Claude and Codex in Type.com: 90 read, 87 write, 34 destructive.

About Lemlist

lemlist is a prospecting tool that automates multichannel outreach, enabling users to find leads with valid contact information and reach them across email, LinkedIn, or calls with personalized messages.

Categories: Marketing & Social

How to connect Lemlist to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

211 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

211 operations listed.

Self recovery

  • Read

    Get Self-recovery Config

    GET /self-recovery/config

  • Read

    List Self-recovery History

    GET /self-recovery/history

  • Write

    Update Self-recovery Config

    PATCH /self-recovery/config

Message templates

  • Read

    List Message Templates

    Lists the team's library message templates (the templates of the Templates page), newest first, with the page's own filters: a name search, tags and creators. Campaign step bodies are not templates: read them from GET /campaigns/{campaignId}/sequences.

  • Read

    List Message Template Tags

    Lists the distinct tags used on the team's library message templates, alphabetically. search matches inside the tag; userIds keeps the tags of those creators' templates only.

  • Read

    Get Message Template

    Returns one library message template with its body.

Snippets

  • Read

    List Snippets

    Lists the team's snippets (the fragments of the Templates page Snippets), by name, with a name search and a creator filter.

  • Read

    Get Snippet

    Returns one snippet with its content.

Team

  • Read

    Get Team

    GET /team

  • Read

    Get Team Senders

    GET /team/senders

  • Read

    Get Team Credits

    GET /team/credits

  • Read

    Get Team CRM Users

    Lists the team members whose CRM account is connected to lemlist.

Users

  • Read

    Get User

    GET /users/{userId}

  • Read

    Get User Channels

    GET /user/channels

  • Write

    Update User LinkedIn Limits

    PATCH /users/{userId}/linkedin-limits

Campaigns

  • Read

    Get Many Campaigns

    GET /campaigns

  • Read

    Get Campaign

    GET /campaigns/{campaignId}

  • Read

    Start Campaign Stats Export

    Start an asynchronous export of all campaign statistics. The final export result is a CSV file.

  • Read

    Get Campaign Export Status

    Check the status of an asynchronous campaign export.

  • Read

    Export Campaign Leads

    Export leads from a campaign with filtering options. Returns leads in CSV or JSON format based on their state (e.g., contacted, interested, replied, etc.).

  • Read

    Get Campaign Reports

    Retrieve reports for one or multiple campaigns. Returns aggregated statistics and export status for the specified campaigns.

  • Read

    Get Campaign Stats

    Retrieve detailed statistics for a specific campaign, with filtering options by date, user, A/B testing, and communication channels.

  • Read

    Get Batch Campaign Stats

    Retrieve detailed statistics for multiple campaigns in a single request, with filtering options by date, user, A/B testing, and communication channels. Processes up to 100 campaigns per request.

  • Read

    Get Campaign Statutes

    Retrieves validation statutes for a campaign, including errors that block launching and warnings about daily limits, DNS issues, etc. Uses the same validation engine as the lemlist UI.

  • Write

    Create Campaign

    POST /campaigns

  • Write

    Update Campaign

    PATCH /campaigns/{campaignId}

  • Write

    Pause Campaign

    POST /campaigns/{campaignId}/pause

  • Write

    Skip Step for Everyone

    Skip one step of a running campaign for every lead. Cannot be undone.

  • Write

    Skip Step for Leads

    Skip one step of a running campaign for a list of leads, at most 100 per call. Each item is a lead id or an email. Cannot be undone.

  • Write

    Start Campaign

    POST /campaigns/{campaignId}/start

  • Write

    Duplicate Campaign

    POST /campaigns/{campaignId}/duplicate

  • Destructive

    Set Email for Campaign Export Notification

    Set an email address for a given export. When the export is done, an email with the download URL will be sent to the address provided.

Signal Agents

  • Read

    Get Signal Agent signals

    GET /watchlist/signals

  • Read

    List Signal Agents

    GET /watchlist

  • Read

    Get Signal Agent configuration history

    GET /watchlist/history

  • Read

    List available signal types

    GET /watchlist/library

  • Read

    List allowed filters per signal type

    GET /watchlist/filters

  • Read

    Autocomplete filter values

    GET /watchlist/filter-values

  • Write

    Add Signal Agent Trigger

    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.

  • Write

    Push external signals

    POST /watchlist/{watchListId}/external-signals

  • Write

    Create Signal Agent

    POST /watchlist

  • Write

    Update Signal Agent

    PATCH /watchlist

  • Write

    Monitor CRM Lists with a Signal Agent

    Switches a Signal Agent to the CRM list source and monitors every company (or contact) of the given CRM lists. The lists replace the ones it monitored: entities left out stop being monitored. Only companies with a domain and contacts with a LinkedIn URL are monitored.

  • Destructive

    Remove Signal Agent Trigger

    Detaches a Signal Agent from a campaign's signal triggers. Leads already pushed stay in the campaign.

  • Destructive

    Mark signals handled or ignored

    Bulk-set the status of one or several signals to handled or ignored.

  • Destructive

    Delete Signal Agent

    DELETE /watchlist

Sequences

  • Read

    Get Campaign Sequences

    GET /campaigns/{campaignId}/sequences

  • Read

    List Condition Branches

    Every branch of a condition step, in execution order, with the Else branch last. A condition step holds an ordered list of branches, each owning the sub-sequence the leads it matches walk into.

  • Read

    Get Step Sender

    Returns the forced sender of a step. A step without a forced sender uses the sender strategy of the campaign. Requires the Email Pro plan.

  • Read

    Get A/B Test Variant

    Returns variant B (subject, message, config) of the A/B test on a step. Requires the Email Pro plan.

  • Write

    Add Step to Sequence

    POST /sequences/{sequenceId}/steps

  • Write

    Update Sequence Step

    PATCH /sequences/{sequenceId}/steps/{stepId}

  • Write

    Add Condition Branch

    Adds a branch to a condition step, just before the Else branch, and mints the empty sub-sequence it routes to. Add steps to that branch by calling POST /sequences/{sequenceId}/steps with the returned sequenceId.

  • Write

    Reorder Condition Branches

    Rewrites the execution priority of a condition step's branches. Order is priority: the first branch whose test matches takes the lead. order must list every non-fallback branch of the step exactly once.

  • Write

    Update Condition Branch

    Renames a branch and/or changes what it tests. Send only the halves you want to change. The two halves are gated differently once leads have entered the campaign: a rename still goes through, while re-selecting what the branch tests is refused with 409.

  • Write

    Create A/B Test Variant

    Creates variant B of an A/B test on a step, prefilled from variant A, and starts the test (leads are split between A and B). Supported on email, linkedinInvite, and linkedinSend steps. Requires the Email Pro plan.

  • Write

    Update A/B Test Variant

    Edits variant B content/config of the A/B test on a step. Only the provided fields are updated; unknown fields are rejected. Allowed while the campaign is running. Requires the Email Pro plan.

  • Write

    Select A/B Test Winner

    Selects the winning variant of the A/B test. The winning template is then sent to all remaining leads going through the campaign. Requires the Email Pro plan.

  • Destructive

    Delete Sequence Step

    DELETE /sequences/{sequenceId}/steps/{stepId}

  • Destructive

    Delete Condition Branch

    Removes a branch and the whole sub-tree behind it - the branch's own sub-sequence, and every sequence only reachable through it. removedSequenceIds lists what was deleted alongside the branch entry; a sequence another step still points at is left alone.

  • Destructive

    Set Step Sender

    Forces a sender on a step, as the campaign editor does. The step then always sends from this team member, whatever sender the lead got. On a running campaign, the pending tasks of the step move to this sender. Requires the Email Pro plan.

  • Destructive

    Remove Step Sender

    Removes the forced sender of a step. The step uses the sender strategy of the campaign again. On a running campaign, the pending tasks of the step move to a sender of the pool. Requires the Email Pro plan.

  • Destructive

    Delete A/B Test Variant

    Deletes a variant of the A/B test and ends the test. Deleting B (default) drops variant B; deleting A promotes variant B to A. Requires the Email Pro plan.

Senders

  • Read

    List Senders

    Lists the team members who can send, with their channels and the health of each channel. With campaignId, each sender and each channel tells whether the campaign pool enables it.

  • Read

    Get Campaign Senders

    Returns the sender pool of a campaign, as the campaign editor shows it: each sender with its enabled channels and their diagnostics. Requires the Email Pro plan.

  • Write

    Add Campaign Senders

    Adds senders, or channels of senders, to the pool of a campaign. It never removes a sender or a channel. Requires the Email Pro plan.

  • Write

    Update Campaign Sender Channels

    Enables or disables channels of one sender in the pool of a campaign, or changes the alias of a mailbox. The changes apply in order. The other channels of the sender do not change. Requires the Email Pro plan.

  • Destructive

    Replace Campaign Senders

    Replaces the pool of a campaign with the senders of the body. A sender or a channel outside the body leaves the pool. An empty list clears the pool. Requires the Email Pro plan.

  • Destructive

    Remove Campaign Sender

    Removes one sender, with every channel, from the pool of a campaign. The leads not contacted yet go to the other senders of the pool. Requires the Email Pro plan.

Schedules

  • Read

    Get Many Schedules

    GET /schedules

  • Read

    Get Schedule

    GET /schedules/{scheduleId}

  • Read

    Get Campaign Schedules

    GET /campaigns/{campaignId}/schedules/

  • Write

    Create Schedule

    POST /schedules

  • Write

    Update Schedule

    PATCH /schedules/{scheduleId}

  • Write

    Associate Schedule with Campaign

    POST /campaigns/{campaignId}/schedules/{scheduleId}

  • Destructive

    Delete Schedule

    DELETE /schedules/{scheduleId}

Leads

  • Read

    Get Lead by Email or ID

    Retrieve a lead using either their email address or lead ID

  • Read

    Get Lead by Email

    GET /leads/{email}

  • Read

    Get Campaign Leads

    GET /campaigns/{campaignId}/leads/

  • Read

    Get CRM Filters

    Lists the filters leads can be imported from, in the CRM your team is connected to: HubSpot contact lists, Salesforce list views or reports, Pipedrive filters. Pass the returned id to Import Leads from CRM.

  • Write

    Create Lead in Campaign

    Creates a new lead in the campaign, never updates one: a contact that already has a lead in this campaign is refused with 400 LEADALREADYINCAMPAIGN and nothing is written, on the lead, the contact or the company.

  • Write

    Update Lead in a Campaign

    Updates an existing lead and, through it, the contact and the company the lead is linked to: contact fields such as firstName or jobTitle are written on the contact, company fields such as companyName on the company. Only the fields in the body change.

  • Write

    Resume Paused Lead

    POST /leads/start/{leadId}

  • Write

    Pause Lead

    POST /leads/pause/{leadId}

  • Write

    Launch Lead

    Use this endpoint to launch a lead that is waiting for review, without having to enable campaign-wide auto-review.

  • Write

    Mark Lead as Interested

    Mark a lead as interested across all campaigns

  • Write

    Mark Lead as Not Interested

    Mark a lead as not interested across all campaigns

  • Write

    Mark Lead as Interested in Campaign

    POST /campaigns/{campaignId}/leads/{leadIdOrEmail}/interested

  • Write

    Mark Lead as Not Interested in Campaign

    POST /campaigns/{campaignId}/leads/{leadIdOrEmail}/notinterested

  • Write

    Add Custom Variables on Leads

    Add custom variables to a lead and sets values for that specific lead.

  • Write

    Update Values of Custom Variables of a Lead

    Update values of custom variables for a lead. Default variables follow the Update Lead rules: they are written on the lead's contact and company as well, and companyName alone renames the company the lead is linked to.

  • Write

    Upload Audio for Voice Message Step

    POST /leads/audio

  • Write

    Import Leads from CRM

    Links a campaign to a filter of your connected CRM and imports its records as leads. Recurring: the campaign stays linked to the filter, and the records the filter picks up later are imported automatically. New link only: the campaign must not be linked to a CRM filter yet.

  • Destructive

    Unsubscribe Lead from Campaign

    DELETE /campaigns/{campaignId}/leads/

  • Destructive

    Delete or Unsubscribe Lead

    DELETE /campaigns/{campaignId}/leads/{leadId}

  • Destructive

    Unsubscribe Lead from Campaign

    DELETE /campaigns/{campaignId}/leads/{email}

  • Destructive

    Personalize Step for Lead

    Personalize the message of one campaign step for a single lead. The lead receives this version instead of the step's shared content, and is no longer A/B tested on this step.

  • Destructive

    Reset Step Personalization for Lead

    Remove a lead's personalization of one campaign step: the lead receives the step's shared message again. The personalized content cannot be recovered.

  • Destructive

    Erase Values of Custom Variables on a Lead

    Erases the values of custom variables on a lead.

CRMs

  • Read

    Get CRM Logs

    Retrieves CRM sync history: every operation lemlist ran with your CRM (creation, update, activity, association…), newest first, with its outcome and the CRM's error message when it failed. Internal steps of the sync engine are not listed. Available from the Email Pro plan.

People Database

  • Read

    Get Database Filters

    GET /database/filters

  • Read

    Search People Database

    This endpoint allows you to query our People database. To do so, you may use the following parameters: filters (required, unless fromSearchId is provided), fromSearchId (optional), page (optional), size (optional), and excludes (optional).

  • Read

    Search Companies Database

    Search the lemlist Companies database using structured filters with pagination support. Returns comprehensive company data including technologies used, location, employee count, and other business intelligence.

  • Read

    Export People database search

    Exports the People Database leads matching a search as a CSV file. The response is streamed as text/csv with a Content-Disposition: attachment header.

  • Read

    Export Companies database search

    Exports the companies matching a search as a CSV file. The response is streamed as text/csv with a Content-Disposition: attachment header.

  • Read

    List Personas

    Lists the personas saved by your team. A persona is a named, reusable set of People Database filters; its id can then be referenced elsewhere in the API, for example through the persona filter of a Signal Agent. Personas are team-shared: every member sees the same list.

  • Read

    List Saved Searches

    Lists the People Database saved searches of your team, sorted by name. Saved searches are team-shared: every member sees the same list.

  • Read

    Get Saved Search

    Retrieves one of your team's saved searches. An unknown id and a saved search belonging to another team answer the same 404.

  • Write

    Create Persona

    Creates a persona for your team from a name and a set of People Database filters. Use Get Database Filters to discover the valid filterId values. Filters carry no type property: it is derived from filterId server-side.

  • Write

    Create Saved Search

    Creates a People Database saved search for your team. It shows up in the "Saved searches" menu of the People Database.

  • Write

    Update Saved Search

    Renames a saved search and/or replaces its filters. At least one of name and filters is required. filters replace the saved filters entirely: they are not merged. mode is only read together with filters and defaults to the current mode of the saved search.

  • Destructive

    Delete Persona

    Permanently deletes one of your team's personas. There is no undo. An unknown id, a persona belonging to another team, and the persona lemlist auto-generates from your AI business context all answer the same 404: they are indistinguishable by design.

  • Destructive

    Delete Saved Search

    Permanently deletes one of your team's saved searches. There is no undo. An unknown id and a saved search belonging to another team answer the same 404.

Tasks

  • Read

    Search Tasks

    Searches the team's tasks with the same vocabulary as the Tasks page: flat query parameters for the common filters, and an advancedFilters tree for everything else. Every status is returned unless status narrows it.

  • Read

    List Task Filters

    Lists every field addressable by advancedFilters on GET /v2/tasks, with its type, its allowed operators and the flat query parameter that addresses it, when there is one. The team's custom fields are included.

  • Write

    Create Task

    Create a manual task (opportunity) associated with a contact/company or lead.

  • Write

    Update Task

    Update task details such as assignment, due date, title, message, priority, or completion status.

  • Write

    Ignore Tasks

    POST /tasks/ignore

Inbox

  • Read

    Get Many Inboxes

    GET /inbox

  • Read

    Get Contact Messages

    GET /inbox/{contactId}

  • Read

    Get Many Labels

    List all labels available to your team.

  • Read

    Get Label

    Get info of a specific label.

  • Read

    List Drafts

    Lists all non-deleted drafts for a specific contact.

  • Read

    Get Draft

    Retrieves a single draft with its full content, including attachments.

  • Write

    Send Email

    POST /inbox/email

  • Write

    Send LinkedIn Message

    POST /inbox/linkedin

  • Write

    Send WhatsApp Message

    POST /inbox/whatsapp

  • Write

    Send SMS Message

    Sends an SMS to a contact through the lemlist inbox. The message is sent to the contact's phone number (phone field, or the first entry of phones). Sending consumes SMS credits, one per message segment.

  • Write

    Create Label

    Creates a new label available to the team.

  • Write

    Attach Labels to Conversations

    Attaches one or more labels to one or more conversations.

  • Write

    Create Draft

    Creates a new draft for a specific contact. The source is automatically set to "api".

  • Write

    Update Draft

    Partially updates an existing draft. Only the provided fields will be updated.

  • Destructive

    Remove Labels from Conversation

    Removes one or more labels from one conversation.

  • Destructive

    Delete Draft

    Soft-deletes a draft by setting its deletedAt timestamp.

Contacts

  • Read

    Get Many Contacts

    Retrieves contacts by IDs/emails or by CRM record ids, or searches/lists contacts by name, email, contact list, campaign membership, or company link. When using idsOrEmails, returns an array of matching contacts directly.

  • Read

    Search & Connect Contacts in the CRM

    Searches your connected CRM for each contact and links it to the CRM record found — the Search & connect action of the Contacts page. No CRM record is ever created: use POST /contacts/crm/create for that.

  • Read

    Get Contact

    Retrieves a contact by its lemlist id (ctcxxx) or email address. The path does not take a CRM record id: use GET /contacts?crmIds= for that.

  • Read

    Get Contact Notes

    Retrieves the notes attached to a contact, newest first by default. The contact is resolved by its id (ctcxxx) or email within your team. Only notes are returned, not the contact's other activities.

  • Read

    Get Contact Lists

    Retrieves all static and dynamic contact lists for the team. Optionally filter by name.

  • Read

    Export Contact List

    Exports contacts or companies from a CRM list as a CSV file. The response is streamed as text/csv with a Content-Disposition: attachment header.

  • Write

    Add and update contact

    Creates a new contact or updates an existing one (upsert). If a contact with the same email, LinkedIn URL, or Sales Navigator URL already exists, it is updated as the updateStrategy query parameter says (by default, sent values replace stored ones and empty values are ignored).

  • Write

    Merge Contacts

    Merges up to 10 lemlist contacts into one. The survivor (primaryId) keeps its id and every value it holds; its empty fields are filled from the other contacts, which are then deleted.

  • Write

    Create Contacts in the CRM

    Pushes contacts to your connected CRM — the Create in CRM action of the Contacts page. Each contact is searched in the CRM first: linked to the record found, created in the CRM otherwise. On Salesforce, asLead: true creates the missing contacts as Leads.

  • Write

    Create Contact Note

    Writes a note on a contact resolved by its id (ctcxxx) or email, exactly as a note written in the lemlist app: it is stored as a note of the contact, pushed to your connected CRM (HubSpot, Salesforce, Pipedrive) like an in-app note, and logged in the team activity feed.

  • Write

    Create Contact List

    Creates a new static contact list. After creating the list, use POST /contacts/lists/{listId}/entities to add contacts to it.

  • Write

    Add or Remove Contacts in a List

    Adds existing CRM contacts to a static contact list, or removes them when ?action=remove is set. - Add (default): send a POST with a contactIds body. Contacts already in the list are silently skipped (no duplicates) and reported in alreadyInList.

  • Destructive

    Delete Contact

    Deletes a lemlist contact resolved by its id (ctcxxx) or email. Cascades to the contact's leads, opportunities, list associations, inbox conversations and activities. No CRM-side propagation — only the lemlist record is removed.

Lemwarm

  • Read

    Get warmup errors

    Lists the mailboxes of your team that lemwarm keeps out of warmup, with the cause and the fix for each one. Paused mailboxes come first, then warnings (temporary locks), newest first. Healthy or manually paused mailboxes are not returned.

  • Read

    Get lemwarm Settings

    GET /lemwarm/{userMailboxId}/settings

  • Write

    Start lemwarm

    POST /lemwarm/{userMailboxId}/start

  • Write

    Pause lemwarm

    POST /lemwarm/{userMailboxId}/pause

  • Write

    Update lemwarm Settings

    PATCH /lemwarm/{userMailboxId}/settings

Companies

  • Read

    Get Many Companies

    Retrieves companies by IDs/domains or by CRM record ids, or lists them with filters. When using idsOrDomains, returns the matching companies in data, with total and no pagination.

  • Read

    Get Company Lists

    Retrieves all static and dynamic company lists for the team. Optionally filter by name.

  • Read

    Search & Connect Companies in the CRM

    Searches your connected CRM for each company and links it to the CRM record found — the Search & connect action of the Companies page. No CRM record is ever created: use POST /companies/crm/create for that.

  • Read

    Get Company

    Retrieves one lemlist company by its id (cpnxxx) and returns the company object itself, unwrapped. Answers 404 COMPANYNOTFOUNDBYID when no company of your team carries this id, where GET /companies?idsOrDomains= answers 200 with an empty data array.

  • Read

    Get Company Notes

    GET /companies/{companyId}/notes

  • Write

    Add and update company

    Creates a new company or updates an existing one (upsert). If a company with the same domain, LinkedIn URL, or Sales Navigator URL already exists, it is updated as the updateStrategy query parameter says (by default, sent values replace stored ones and empty values are ignored).

  • Write

    Create Company List

    Creates a new static company list. After creating the list, use POST /companies/lists/{listId}/entities to add companies to it.

  • Write

    Add or Remove Companies in a List

    Adds existing CRM companies to a static company list, or removes them when ?action=remove is set. - Add (default): send a POST with a companyIds body. Companies already in the list are silently skipped (no duplicates) and reported in alreadyInList.

  • Write

    Merge Companies

    Merges up to 10 lemlist companies into one. The survivor (primaryId) keeps its id and every value it holds; its empty fields are filled from the other companies, which are then deleted.

  • Write

    Create Companies in the CRM

    Pushes companies to your connected CRM — the Create in CRM action of the Companies page. Each company is searched in the CRM first: linked to the record found, created in the CRM otherwise.

  • Write

    Create Company Note

    POST /companies/{companyId}/notes

  • Destructive

    Delete Company

    Deletes a lemlist company. Refuses by default when contacts are still attached — pass force=true to detach them (the companyId field is unset on each contact) before deleting the company. No CRM-side propagation: only the lemlist record is removed.

Activities

  • Read

    Get Many Activities

    With version=v2, each activity nests its lead under lead: the v2 lead object of GET /leads/{email}, createdAt included.

  • Destructive

    Delete Activity Recording & Transcript

    DELETE /activities/{activityId}/recording-transcript

Calls

  • Read

    Get a Call

    Reads a call of the team back: any call by its id, whatever dialer made it (the lemlist dialer, Aircall, Ringover or this API), or a call logged through POST /calls by the externalId you sent.

  • Read

    Get Call Statuses

    Lists the team's active call statuses (dispositions): lemlist's defaults and the team's own, as the dialer shows them. key is what POST /calls and PATCH /calls/{id} take as callStatus; the flags say what the team configured the status to do.

  • Write

    Log a Call

    Logs a call made outside lemlist, as an external dialer reports it.

  • Write

    Update a Call

    Completes a call logged through POST /calls with what your dialer learns afterwards: the call status, a note, the duration, the recording, the transcript. Send at least one field; the others stay as they are. A field sent as null counts as absent.

Unsubscribes

  • Read

    List Unsubscribed Variables

    Retrieves a paginated list of all unsubscribed variables (emails, domains, LinkedIn URLs, phone numbers).

  • Read

    Get Unsubscribed Variable

    Retrieves a specific unsubscribed variable by its value.

  • Read

    Get Contact Subscription Status

    Checks whether a contact is unsubscribed (do-not-contact).

  • Read

    Export Unsubscribed Variables

    Exports all unsubscribed variables. The response is a CSV file by default. Set format=json to get a JSON array.

  • Read

    Export Unsubscribed Contacts

    Exports all contacts with their subscription status. The response is a CSV file by default. Set format=json to get a JSON array.

  • Write

    Bulk Unsubscribe Variables

    Unsubscribes up to 10,000 variables in a single request.

  • Write

    Unsubscribe Variable

    Unsubscribes a single variable. This operation is idempotent — if the variable is already unsubscribed, the existing record is returned.

  • Write

    Unsubscribe Contact

    Marks a contact as unsubscribed (do-not-contact).

  • Destructive

    Re-subscribe Variable

    Removes a variable from the unsubscribe list. Variables with a protected source (LEAD or ABUSE) cannot be re-subscribed.

  • Destructive

    Re-subscribe Contact

    Removes the unsubscribed (do-not-contact) flag from a contact.

Webhooks

  • Read

    Get Many Webhooks

    GET /hooks

  • Write

    Add Webhook

    POST /hooks

  • Destructive

    Delete Webhook

    DELETE /hooks/{hookId}

Enrich

  • Read

    Get Enrichment Result

    Read the state and result of an enrichment started with Enrich Data, Enrich Lead or Bulk Enrich Data. The HTTP status follows enrichmentStatus: 200 done, 202 in-progress, 400 failed, 404 not-found. Prefer webhooks to polling: see the Enrichment object.

  • Write

    Enrich Data

    Start one enrichment for one person. Answers with the enrichment id right away; the result comes later through webhooks or Get Enrichment Result. Every call starts a new enrichment and uses credits, even for a person enriched before.

  • Write

    Bulk Enrich Data

    Send a batch of enrichment requests for multiple entities. Maximum 500 enrichment requests per call. Each row answers with its own enrichment id, or with an error code and a message when that row could not be started. A malformed row rejects the whole call with a 400.

  • Write

    Enrich Lead

    Start an enrichment of a lead of your team, from the data of its contact. Enable at least one of findEmail, findPhone, verifyEmail and linkedinEnrichment. Answers with the enrichment id right away; the result comes later through webhooks or Get Enrichment Result.

Email Accounts

  • Write

    Connect Email Account

    POST /user/email-accounts

  • Write

    Test Email Account

    POST /user/email-accounts/{emailAccountId}/test

  • Destructive

    Disconnect Email Account

    Disconnects an SMTP/IMAP email account of the team. Permission: only the owner of the email account, or an admin of the team when the owner is a member of it, can disconnect it. Otherwise the request fails with 403 and nothing is disconnected.

Fields

  • Read

    List Fields

    GET /fields

  • Write

    Create or Update Field

    Creates a custom field on contacts or companies, or updates the one the entity already has under that name, under the rules of the lemlist app: the same reserved names, the same type conversions, the same permission. Create.

  • Destructive

    Delete Field

    Deletes a custom field, as the app does: the API key user needs the Update contact & companies fields permission; a contact field a campaign still picks its sender through is refused (409); then the field is removed from every contact or company of the team and from your CRM fie…

Deliverability alerts

  • Read

    List Deliverability Alerts

    GET /deliverability/alerts

  • Read

    Get Deliverability Alert

    GET /deliverability/alerts/{alertId}

  • Read

    List Deliverability Incidents

    Lists your team's deliverability incidents, newest first: DNS issues that lock sending, mailboxes disconnected from lemlist, mailboxes disconnected while warming up, and warm-ups paused by lemwarm.

  • Write

    Create Deliverability Alert

    POST /deliverability/alerts

  • Write

    Update Deliverability Alert

    PATCH /deliverability/alerts/{alertId}

  • Destructive

    Delete Deliverability Alert

    DELETE /deliverability/alerts/{alertId}

Sender picture

  • Read

    Get Sender Picture Status

    Lists the mailboxes a user bought through lemlist in your team, with whether their lemlist profile picture has been pushed to each one. Only active mailboxes assigned to the user are returned. Omit userId to read your own mailboxes; a teammate's userId must belong to your team.

  • Write

    Sync Sender Picture

    Queues a push of a user's lemlist profile picture onto the Google Workspace and Microsoft 365 mailboxes they bought through lemlist, so recipients see it next to their emails. The push is asynchronous: the call only queues it.

Contact sourcing

  • Read

    Get Contact Sourcing Run

    Reads one contact-sourcing run — by its own id, or the latest run of an account. The HTTP status carries the run state: 200 the run completed and contacts is filled, 202 the run is still queued or going (poll again), 400 the run failed and error says why, 404 no such run.

  • Write

    Run Contact Sourcing

    Starts an AI contact-sourcing run for one or more accounts: sources each company's employees from the People Database and classifies them into a buying committee (decision maker / user / influencer) with an ICP fit score.

  • Write

    Add a Sourced Contact

    Turns one contact-sourcing recommendation into a lemlist contact. leadId comes from a run's contacts[].leadId — a People-Database id, not a contact id.

Enrichment Providers

  • Read

    List Enrichment Providers

    Lists the providers your team can place in a waterfall, for one enrichment type. This is the catalog of legal providers[].id values for the waterfall endpoints: read it before creating or updating a waterfall.

  • Destructive

    Connect Provider

    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.

  • Destructive

    Disconnect Provider

    Removes your API key for an external provider. lemlist stops calling it on your account and removes it from your custom waterfalls.

Enrichment Waterfalls

  • Read

    List Enrichment Waterfalls

    Lists the waterfalls of your team: the default waterfall of each type, plus every custom waterfall. Default waterfalls come first, then custom waterfalls by creation date, most recent first. Waterfalls are team-shared: every member sees the same list.

  • Read

    Get Enrichment Waterfall

    Returns one waterfall of your team, default or custom.

  • Write

    Update Enrichment Waterfall

    Updates the name or providers of a waterfall. Only the fields present in the body change; type and isDefault cannot change, and conditions is rejected with a 400. When providers is sent it replaces the whole order; providers you leave out are appended, disabled.

  • Destructive

    Reset Enrichment Waterfall

    Hands a default waterfall back to lemlist: editor becomes lemlist and the provider order is random again, as if nobody had ever edited it. The reset waterfall is returned.

See How connections work for access and permissions, or browse all integrations.

Reference date: October 27, 2026. Lemlist API docs.