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

Account

me

account.me Read the user and organization the API key belongs to, with the key’s role Risk: read
Input: empty object Output

Campaigns

create

campaigns.create Create a campaign in draft from a sequence graph; it contacts nobody until campaigns.update sets it active Risk: write
Input The campaign starts in draft and contacts nobody until campaigns.update sets status active.
Output

delete

campaigns.delete Archive a campaign: it stops sending and leaves the active list, and the record is kept Risk: destructive
Input Output

enroll

campaigns.enroll Enroll up to 500 leads at once, with one result per lead so a batch can partly succeed; an enrolled lead can be contacted Risk: destructive · Irreversible
Input One result comes back per lead, so a batch can partly succeed; a skipped entry carries the reason. Output

get

campaigns.get Read one campaign, including its sequence graph and status Risk: read
Input Output

leads

campaigns.leads Page through the leads enrolled in a campaign with their status Risk: read
Input Output

list

campaigns.list Page through campaigns, optionally filtered by status Risk: read
Input Output

stats

campaigns.stats Read a campaign’s progress and funnel: invites, messages, replies, and why leads were skipped Risk: read
Input Output

stopLeads

campaigns.stopLeads Stop leads in a campaign so no further step reaches them, keeping them in the list Risk: write
Input Output

update

campaigns.update Rename a campaign, replace its graph, or set active to start sending and paused to halt it; going active begins contact and cannot be undone Risk: destructive · Irreversible
Input
Output

Compose

preview

compose.preview Preview an AI-composed message for a lead without sending it, with the context sources it used Risk: read
Input Output

Leads

create

leads.create Create a lead with a LinkedIn or Instagram identity; a duplicate identity is refused with 409, so use leads.upsert to merge instead Risk: write
Input A duplicate identity is refused with 409; use leads.upsert to merge instead.
Output

delete

leads.delete Delete a lead and its identities permanently; there is no restore call Risk: destructive · Irreversible
Input Output

get

leads.get Read one lead by id, with its identities and live enrollment Risk: read
Input Output

list

leads.list Page through the workspace’s leads by cursor Risk: read
Input Output

leads.search Search leads by free text and structured filters, combined with AND, paged by cursor Risk: read
Input
Output

update

leads.update Patch a lead’s fields by id; sending identities replaces the whole set rather than adding to it Risk: write
Input Sending identities replaces the whole identity set rather than adding a channel.
Output

upsert

leads.upsert Create the lead, or patch the fields onto the one an identity already belongs to, reporting created or matched Risk: write
Input Answers created or matched; on a match it patches the fields sent onto the existing lead.
Output

Places

search

places.search Search places by free text or around a point, returning addresses, coordinates and websites Risk: read
Input
Output

Suppressions

check

suppressions.check Check up to 1000 identities against the suppression list and answer contactable with the reason when not Risk: read
Input Run this before enrolling; Needle also applies its own suppression policy during a send.
Output

create

suppressions.create Suppress up to 1000 leads or company domains, with counts for what was created and what was already listed Risk: write
Input
Output

delete

suppressions.delete Remove a suppression entry, which makes that person or domain contactable again Risk: destructive
Input Output

list

suppressions.list Page through suppression entries, optionally filtered by reason Risk: read
Input Output