Skip to main content
New to Corsair? See API access, authentication, and error handling.

Activities

deleteRecordingTranscript

activities.deleteRecordingTranscript Delete call recording and transcript of an activity Risk: destructive
Input Output

list

activities.list Retrieve outreach activities across team or campaigns Risk: read
Input Output: object[]

Campaigns

addAbmLeads

campaigns.addAbmLeads Add People Database contacts to an ABM campaign Risk: destructive
Input Requires the ABM beta. Input IDs are People Database IDs, and existing contacts on another company may be skipped. Output

archive

campaigns.archive Archive a campaign Risk: write
Input Output

create

campaigns.create Create a new campaign with schedule and settings Risk: write
Input Output

duplicate

campaigns.duplicate Duplicate an existing campaign with sequences and schedules Risk: write
Input Output

exportLeads

campaigns.exportLeads Export leads from campaign with state filtering Risk: read
Input JSON output is an array; CSV output is returned as text. Use documented comma-separated state filters. Output: Record<string, string \| number \| boolean \| null>[] \| string

get

campaigns.get Retrieve details of a specific campaign by ID Risk: read
Input Output

getBatchStats

campaigns.getBatchStats Retrieve performance statistics for multiple campaigns Risk: read
Input Output

getExportStatus

campaigns.getExportStatus Check status of an asynchronous campaign export Risk: read
Input Export status is retained for two hours; an export still pending after two hours answers 404, so stop polling and report it as failed. Files are available for 24 hours after completion. Output

getReports

campaigns.getReports Retrieve aggregated reports for one or multiple campaigns Risk: read
Input Output: object[]

getSettings

campaigns.getSettings Retrieve all settings of a campaign Risk: read
Input Requires the Lemlist Email Pro plan or higher. Output

getStats

campaigns.getStats Retrieve performance statistics for a specific campaign Risk: read
Input Output

getStatutes

campaigns.getStatutes Retrieve validation statutes and launch blockers for a campaign Risk: read
Input Output

list

campaigns.list Retrieve a paginated list of all campaigns in team Risk: read
Input Returns one page as { campaigns, pagination }; use page and limit to walk the rest. Output

pause

campaigns.pause Pause a running campaign Risk: write
Input Output

setExportEmail

campaigns.setExportEmail Email the campaign export download link to an address when the export completes Risk: destructive
Input Lemlist emails the export’s download link to this address when the export completes, so only use an address the account owner chose. Output

skipStepForEveryone

campaigns.skipStepForEveryone Skip one sequence step for every lead in campaign Risk: destructive
Input A skipped step cannot be restored. Condition steps are not skippable. Output

skipStepForLeads

campaigns.skipStepForLeads Skip one sequence step for specific leads in campaign Risk: destructive
Input Accepts up to 100 lead IDs or emails per request; the deprecated single-lead operation remains available at leads.skipStep. Output

start

campaigns.start Resume a paused campaign and allow its outreach messages to send Risk: destructive
Input Output

startExport

campaigns.startExport Initiate asynchronous export of campaign statistics Risk: write
Input Starts an asynchronous export. Poll the returned export ID until status is no longer pending; the download URL expires after 24 hours. Output

unarchive

campaigns.unarchive Restore an archived campaign Risk: write
Input Output

update

campaigns.update Update settings and configuration of a campaign Risk: write
Input
Output

updateSettings

campaigns.updateSettings Update settings of a campaign Risk: write
Input Requires Email Pro; send only writable settings sections, and an empty update is rejected.
Output

Leads

addVariables

leads.addVariables Add custom variables to a lead Risk: write
Input Output

createInCampaign

leads.createInCampaign Create a new lead and add it to a campaign Risk: destructive
Input Needs an email or a LinkedIn URL. Always creates a new lead (a contact already in the campaign is refused), but the matched contact and company are updated with the fields you send; updateStrategy defaults to overwrite, use fillEmptyOnly to keep stored values. Additional string body keys are stored as custom variables. Enrichment query options (findEmail, verifyEmail, findPhone, linkedinEnrichment) consume credits. Output

deleteFromCampaign

leads.deleteFromCampaign Remove a lead from a campaign by ID (use leads.unsubscribeFromCampaign to unsubscribe) Risk: destructive
Input Always sends action=remove, which deletes the lead from the campaign. To unsubscribe a lead instead, use leads.unsubscribeFromCampaign. Output

deleteVariables

leads.deleteVariables Erase custom variables of a lead Risk: destructive
Input Output

get

leads.get Retrieve lead by email address or lead ID Risk: read
Input Needs id or email; Lemlist uses the email when both are given. Output: object[]

getByEmail

leads.getByEmail Retrieve lead details by email address Risk: read
Input Output: object[]

getCrmFilters

leads.getCrmFilters Retrieve filters and list views from connected CRM Risk: read
Input Output: object[]

importFromCrm

leads.importFromCrm Import leads from connected CRM filter into campaign Risk: destructive
Input Links the campaign to a filter once and imports asynchronously; requested enrichment features consume credits. Output

listInCampaign

leads.listInCampaign Retrieve leads from a specific campaign Risk: read
Input Output: object[]

markInterested

leads.markInterested Mark lead as interested across all campaigns Risk: write
Input Output: object[]

markInterestedInCampaign

leads.markInterestedInCampaign Mark lead as interested in a specific campaign Risk: write
Input Output

markNotInterested

leads.markNotInterested Mark lead as not interested across all campaigns Risk: write
Input Output: object[]

markNotInterestedInCampaign

leads.markNotInterestedInCampaign Mark lead as not interested in a specific campaign Risk: write
Input Output

pause

leads.pause Pause lead activity across campaigns or in a specific campaign Risk: write
Input Output: object[]

personalizeStep

leads.personalizeStep Personalize step message for a single lead Risk: write
Input Only supported message steps can be personalized, and a lead that has reached the step cannot be changed. Output

resetStepPersonalization

leads.resetStepPersonalization Reset step personalization for a single lead Risk: destructive
Input Output

resume

leads.resume Resume a paused lead in all campaigns or one campaign, allowing outreach to continue Risk: destructive
Input Output: object[]

review

leads.review Manually launch a lead into its campaign, allowing outreach to begin Risk: destructive
Input Launches a single lead and may start outreach. The API key user, campaign, AI variables, and sender must satisfy Lemlist’s launch guards. Output

skipStep

leads.skipStep Skip one step of a running campaign for a single lead Risk: destructive
Input Deprecated by Lemlist in favor of campaigns.skipStepForLeads; skips cannot be undone. Output

unsubscribeFromCampaign

leads.unsubscribeFromCampaign Unsubscribe a lead from a campaign by email Risk: destructive
Input Output

updateInCampaign

leads.updateInCampaign Update lead information in a campaign Risk: write
Input Output

updateVariables

leads.updateVariables Update custom variables of a lead Risk: write
Input Output

Team

get

team.get Retrieve team details and members Risk: read
Input Output

getCredits

team.getCredits Retrieve team remaining credits balance Risk: read
Input: empty object Output

getCrmUsers

team.getCrmUsers List team members connected to CRM Risk: read
Input: empty object Output: object[]

getSenders

team.getSenders Retrieve all team members and their associated campaigns Risk: read
Input Output: object[]

Unsubscribes

bulkUnsubscribeVariables

unsubscribes.bulkUnsubscribeVariables Bulk unsubscribe variables up to 10,000 items Risk: destructive
Input The API accepts up to 10,000 values. It answered a summary object (message, count, values, skippedValues) in our tests, but its reference shows a plain text confirmation, so check for an object before reading the counts; text carries no per-value result. Output: object \| string

exportContacts

unsubscribes.exportContacts Export all contacts with their subscription status in CSV or JSON; filter for doNotContact true to get only opted-out contacts Risk: read
Input Returns every contact with its subscription status, not only opted-out ones; filter on doNotContact true for a suppression list. CSV text by default or a JSON array with format=json. Output: object[] \| string

exportVariables

unsubscribes.exportVariables Export unsubscribed variables in CSV or JSON format Risk: read
Input Returns CSV text by default or a JSON array with format=json. Output: object[] \| string

getContactStatus

unsubscribes.getContactStatus Get subscription status of a contact Risk: read
Input Output

getVariable

unsubscribes.getVariable Get unsubscribed status of a variable Risk: read
Input Output

listVariables

unsubscribes.listVariables List unsubscribed variables (emails, domains, phones) Risk: read
Input Output: object[]

resubscribeContact

unsubscribes.resubscribeContact Re-subscribe a contact by ID Risk: write
Input Output: string

resubscribeVariable

unsubscribes.resubscribeVariable Re-subscribe a variable to allow future outreach Risk: write
Input Lemlist protects unsubscribe records whose source is LEAD or ABUSE from re-subscription. Output: string

unsubscribeContact

unsubscribes.unsubscribeContact Unsubscribe a contact by ID Risk: destructive
Input Output: string

unsubscribeVariable

unsubscribes.unsubscribeVariable Unsubscribe a single variable (email, domain, or phone) Risk: destructive
Input Output