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
Starts the campaign’s automated emails to the lead. Give lead_id, or up to 100 ids in leads.
Output
campaign_lead full type
campaign_lead full type
create
campaigns.create
Create a campaign
Risk: write
campaign_name and owner_id (a user id from users.list) are required. The answer is the campaign itself.
Output
creator full type
creator full type
stats full type
stats full type
duplicate
campaigns.duplicate
Copy a campaign to a new owner
Risk: write
Output
creator full type
creator full type
stats full type
stats full type
list
campaigns.list
List the campaigns
Risk: read
Output
campaigns full type
campaigns full type
listLeads
campaigns.listLeads
List the leads in a campaign
Risk: read
Output
campaign_leads full type
campaign_leads full type
listReplies
campaigns.listReplies
List the replies in a campaign
Risk: read
Output
replies full type
replies full type
removeLead
campaigns.removeLead
Remove a lead from a campaign
Risk: write
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
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
Adds the domain to the do-not-contact list; emails to it stop. The API has no route to remove one.
Output
dnc_domain full type
dnc_domain full type
list
dncDomains.list
List the do-not-contact domains
Risk: read
Output
dnc_domains full type
dnc_domains full type
Events
list
events.list
List activity events, with filters, page by page
Risk: read
Output
events full type
events full type
Lead Fields
list
leadFields.list
List the lead field definitions
Risk: read
lead_fields full type
lead_fields full type
Leads
create
leads.create
Create a lead with its attributes
Risk: write
The lead fields go in
lead; dup “skip” or “update” handles an existing email. The answer is { status, error, lead }.
Output
lead full type
lead full type
get
leads.get
Read one lead by id
Risk: read
Output
lead full type
lead full type
list
leads.list
List leads, with filters, page by page
Risk: read
Numbered pages: pass page 2, 3, … while has_more is true. Filters: status, status_id, updated_after, created_after, email.
Output
leads full type
leads full type
update
leads.update
Update a lead’s status, owner, flags or attributes
Risk: write
Changes status, owner, bounced/optedout flags and the data attributes; keys come from leadFields.list.
Output
lead full type
lead full type
Lead Statuses
list
leadStatuses.list
List the lead status vocabulary
Risk: read
lead_statuses full type
lead_statuses full type
Tags
list
tags.list
List the tags
Risk: read
Output
Users
list
users.list
List the team members
Risk: read
Output
users full type
users full type
Webhooks
getSettings
webhooks.getSettings
Read the webhook plugin settings
Risk: read
updateSettings
webhooks.updateSettings
Turn webhook deliveries on or off and set the URL each one posts to
Risk: write
Each delivery type (new lead, updated lead, raw events, email reply, email opened) has its own on/off flag and URL.
Output