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

Campaigns

addLead

campaigns.addLead Add leads to a campaign; the campaign’s automated emails start going to them Risk: destructive
Input Starts the campaign’s automated emails to the lead. Give lead_id, or up to 100 ids in leads. Output

create

campaigns.create Create a campaign Risk: write
Input campaign_name and owner_id (a user id from users.list) are required. The answer is the campaign itself. Output

duplicate

campaigns.duplicate Copy a campaign to a new owner Risk: write
Input Output

list

campaigns.list List the campaigns Risk: read
Input Output

listLeads

campaigns.listLeads List the leads in a campaign Risk: read
Input Output

listReplies

campaigns.listReplies List the replies in a campaign Risk: read
Input Output

removeLead

campaigns.removeLead Remove a lead from a campaign Risk: write
Input PersistIQ answers 200 with no body; the operation echoes the removed lead id. Output

replyToMessage

campaigns.replyToMessage Reply to a message received in a campaign; the email goes out and cannot be recalled Risk: destructive · Irreversible
Input Queues the reply email at once; it cannot be recalled. inbox_message_id is a reply id from listReplies. Output

Dnc Domains

create

dncDomains.create Add a domain to the do-not-contact list; emails to it stop Risk: write
Input Adds the domain to the do-not-contact list; emails to it stop. The API has no route to remove one. Output

list

dncDomains.list List the do-not-contact domains Risk: read
Input Output

Events

list

events.list List activity events, with filters, page by page Risk: read
Input Output

Lead Fields

list

leadFields.list List the lead field definitions Risk: read
Input: empty object Output

Leads

create

leads.create Create a lead with its attributes Risk: write
Input The lead fields go in lead; dup “skip” or “update” handles an existing email. The answer is { status, error, lead }. Output

get

leads.get Read one lead by id Risk: read
Input Output

list

leads.list List leads, with filters, page by page Risk: read
Input Numbered pages: pass page 2, 3, … while has_more is true. Filters: status, status_id, updated_after, created_after, email. Output

update

leads.update Update a lead’s status, owner, flags or attributes Risk: write
Input Changes status, owner, bounced/optedout flags and the data attributes; keys come from leadFields.list. Output

Lead Statuses

list

leadStatuses.list List the lead status vocabulary Risk: read
Input: empty object Output

Tags

list

tags.list List the tags Risk: read
Input Output

Users

list

users.list List the team members Risk: read
Input Output

Webhooks

getSettings

webhooks.getSettings Read the webhook plugin settings Risk: read
Input: empty object Output

updateSettings

webhooks.updateSettings Turn webhook deliveries on or off and set the URL each one posts to Risk: write
Input Each delivery type (new lead, updated lead, raw events, email reply, email opened) has its own on/off flag and URL. Output