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

Automations

deliverabilityRate

automations.deliverabilityRate List automation deliverability Risk: read
Input Output

linksTracking

automations.linksTracking List automation link tracking Risk: read
Input Output

list

automations.list List automations Risk: read
Input Output

opensAndClicks

automations.opensAndClicks List automation opens and clicks Risk: read
Input Output

summary

automations.summary Get automation summary Risk: read
Input Output

unsubscribeActivity

automations.unsubscribeActivity List automation unsubscribe activity Risk: read
Input Output

Campaigns

approve

campaigns.approve Approve a campaign Risk: write
Input Output

create

campaigns.create Create a campaign Risk: write
Input
Output

createShipping

campaigns.createShipping Send or schedule a campaign (emails its recipients) Risk: destructive
Input
Output

delete

campaigns.delete Delete a campaign Risk: destructive
Input Output

deleteShipping

campaigns.deleteShipping Cancel a scheduled campaign delivery Risk: destructive
Input Output

deleteTextAlternative

campaigns.deleteTextAlternative Delete campaign text alternative Risk: destructive
Input Output

deliveries

campaigns.deliveries List campaign deliveries Risk: read
Input Output

get

campaigns.get Get a campaign Risk: read
Input Output

getContent

campaigns.getContent Get campaign HTML content Risk: read
Input Output: string

getRecipients

campaigns.getRecipients Get campaign recipients Risk: read
Input Output

getShipping

campaigns.getShipping Get a scheduled campaign delivery Risk: read
Input Output

getSocial

campaigns.getSocial Get campaign social preferences Risk: read
Input Output

getTextAlternative

campaigns.getTextAlternative Get campaign text alternative Risk: read
Input Output

list

campaigns.list List campaigns Risk: read
Input Output

preview

campaigns.preview Preview campaign content Risk: read
Input Output: string \| custom

resultsSummary

campaigns.resultsSummary Get campaign results Risk: read
Input Output

unsubscribed

campaigns.unsubscribed List campaign unsubscribers Risk: read
Input Output

update

campaigns.update Update a campaign Risk: write
Input
Output

updateContent

campaigns.updateContent Update campaign HTML content Risk: write
Input Output

updateRecipients

campaigns.updateRecipients Update campaign recipients Risk: write
Input
Output

updateSocial

campaigns.updateSocial Update campaign social preferences Risk: write
Input
Output

updateTextAlternative

campaigns.updateTextAlternative Update campaign text alternative Risk: write
Input
Output

Fields

list

fields.list List subscriber field definitions Risk: read
Input Output

Home

account

home.account Get the account API home Risk: read
Input Output

get

home.get Get the API home Risk: read
Input: empty object Output

Integrations

delete

integrations.delete Delete integration access Risk: destructive
Input Output

get

integrations.get Get integration access Risk: read
Input Output

update

integrations.update Update integration access Risk: write
Input
Output

Lists

create

lists.create Create a subscriber list Risk: write
Input
Output

delete

lists.delete Delete a subscriber list Risk: destructive
Input Output

get

lists.get Get a subscriber list Risk: read
Input Output

list

lists.list List subscriber lists Risk: read
Input Output

update

lists.update Update a subscriber list Risk: write
Input
Output

Subscribers

archive

subscribers.archive Archive a subscriber Risk: write
Input Output

associate

subscribers.associate Associate a subscriber with a list Risk: write
Input
Output

create

subscribers.create Create or update a subscriber Risk: write
Input
Output

deliveries

subscribers.deliveries List subscriber campaign deliveries Risk: read
Input Output

doubleOptIn

subscribers.doubleOptIn Associate a subscriber using double opt-in (emails the subscriber) Risk: destructive
Input
Output

exists

subscribers.exists Check whether a subscriber exists Risk: read
Input Output: boolean

get

subscribers.get Get a subscriber Risk: read
Input Output

import

subscribers.import Import account subscribers Risk: write
Input
Output

importCsv

subscribers.importCsv Import subscribers from CSV Risk: write
Input Output

importToList

subscribers.importToList Import subscribers into a list Risk: write
Input
Output

importUnsubscribed

subscribers.importUnsubscribed Import unsubscribed subscribers Risk: destructive
Input
Output

list

subscribers.list List account subscribers Risk: read
Input Output

listByOrigin

subscribers.listByOrigin List subscribers by origin Risk: read
Input Output

listForList

subscribers.listForList List subscribers in a list Risk: read
Input Output

listUnsubscribed

subscribers.listUnsubscribed List unsubscribed subscribers Risk: read
Input Output

permissionsHistory

subscribers.permissionsHistory Get subscriber permission history Risk: read
Input Output

removeFromList

subscribers.removeFromList Remove a subscriber from a list Risk: write
Input Output

unsubscribe

subscribers.unsubscribe Unsubscribe a subscriber from the account Risk: destructive
Input
Output

Tasks

get

tasks.get Get a task Risk: read
Input Output

importErrors

tasks.importErrors List task import errors Risk: read
Input Output

list

tasks.list List account tasks Risk: read
Input Output

Templates

create

templates.create Create a double opt-in template Risk: write
Input
Output

get

templates.get Get a double opt-in template Risk: read
Input Output

updateContent

templates.updateContent Update double opt-in template HTML Risk: write
Input Output