New to Corsair? See API access, authentication, and error handling.
Account
balance
account.balance
Read the account balance
Risk: read
topup
account.topup
Top up the account balance from the saved card; the amount is charged for real
Risk: destructive
Output
Addresses
validate
addresses.validate
Validate a UK or US postal address and get the corrected form with a validity flag
Risk: read
Output
Campaigns
approve
campaigns.approve
Approve a campaign, locking its design and recipient selection; the lock cannot be undone
Risk: destructive · Irreversible
Output:
boolean \| number
availableDates
campaigns.availableDates
List the dates a campaign can be booked for
Risk: read
Output:
string[]
book
campaigns.book
Book a campaign for dispatch on a date, paying from the balance; this starts a real mailing
Risk: destructive
Output:
boolean \| number
cost
campaigns.cost
Price a campaign: per-piece rates and totals for validated, non-validated and international recipients
Risk: read
Output
create
campaigns.create
Create a campaign for a group from a template, copied design or uploaded artwork; nothing sends until it is booked
Risk: write
Output:
unknown
delete
campaigns.delete
Permanently delete a campaign that has not been booked; this cannot be undone
Risk: destructive · Irreversible
Output:
boolean \| number
get
campaigns.get
Get one campaign by id
Risk: read
Output
list
campaigns.list
List campaigns with status, recipient counts and cost
Risk: read
object[]
Output full type
Output full type
sample
campaigns.sample
Produce a PDF sample of the campaign; the link is valid for 30 minutes
Risk: write
Output:
string
Events
create
events.create
Record an event against a recipient for tracking, conversions and automation triggers
Risk: write
Output:
number \| string
Files
createFolder
files.createFolder
Create a folder in the secure file transfer area
Risk: write
Output:
string
listFolders
files.listFolders
List the folders in the secure file transfer area
Risk: read
object[]
Output full type
Output full type
upload
files.upload
Upload a file by URL into the secure file transfer area
Risk: write
Output
Groups
addRecipients
groups.addRecipients
Add recipients to a group
Risk: write
Output:
number
calculate
groups.calculate
Recalculate a group so its statistics are up to date
Risk: write
Output:
boolean \| number
create
groups.create
Create a new empty mailing group
Risk: write
Output:
string \| number
delete
groups.delete
Delete a mailing group; with delete_recipients the recipients are deleted account-wide, which cannot be undone
Risk: destructive · Irreversible
Output:
boolean \| number
list
groups.list
List mailing groups with recipient counts and import progress, paged with offset and limit
Risk: read
Output:
object[]
Output full type
Output full type
purge
groups.purge
Remove every recipient from a group; with delete_recipients the recipients are deleted account-wide, which cannot be undone
Risk: destructive
Output:
boolean \| number
removeRecipients
groups.removeRecipients
Remove recipients from a group; the recipients stay on the account
Risk: write
Output:
number
Letters
cancel
letters.cancel
Cancel a letter that has not started processing yet
Risk: destructive
Output:
number
create
letters.create
Create and mail a letter merged from a template or PDF; test mode renders a PDF proof without posting or charging
Risk: destructive
recipient full type
recipient full type
get
letters.get
Get one letter mailpiece with its status, tracking and cost
Risk: read
Output
post
letters.post
Post an already mail-merged letter PDF whose address the API reads with OCR; test mode renders a PDF proof without posting or charging
Risk: destructive
Output
Postcards
cancel
postcards.cancel
Cancel a postcard that has not started processing yet
Risk: destructive
Output:
number
create
postcards.create
Create and mail a postcard to one recipient; test mode renders a PDF proof without posting or charging
Risk: destructive
recipient full type
recipient full type
get
postcards.get
Get one postcard mailpiece with its status, tracking and cost
Risk: read
Output
Recipients
create
recipients.create
Create a recipient, optionally into a group, with duplicate handling and custom fields
Risk: write
Output
delete
recipients.delete
Permanently delete a recipient from the account; this cannot be undone
Risk: destructive · Irreversible
Output:
number \| string
get
recipients.get
Get one recipient by id
Risk: read
Output
import
recipients.import
Import a CSV or XLS data file into a group, with column remapping and duplicate handling
Risk: write
Output:
string
list
recipients.list
List recipients with their addresses and blacklist flag, filtered by group and paged with offset and limit
Risk: read
Output:
object[]
Output full type
Output full type
Reporting
list
reporting.list
List mailpieces in a date range, optionally filtered by status, or by status and tag (a tag needs a status)
Risk: read
Output
singles full type
singles full type
summary
reporting.summary
Count mailpieces per delivery status within a date range
Risk: read
Output
Selections
create
selections.create
Create an auto-filter selection that targets a subset of a group
Risk: write
Output:
object[] \| boolean
Output full type
Output full type
Sms
create
sms.create
Send an SMS to a phone number or stored recipient; test mode builds it without sending or charging
Risk: destructive
Output
Tools
pdfMerge
tools.pdfMerge
Merge several PDFs by URL into one file
Risk: read
Output:
string
templates
tools.templates
List the design templates on the account
Risk: read
object[]
Output full type
Output full type