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

Creatives

get

creatives.get Get a saved creative. Risk: read
Input Output

list

creatives.list List saved creatives. Risk: read
Input Output

Estimate

giftcard

estimate.giftcard Estimate gift-card costs without sending. Risk: read
Input
Output

magnacard

estimate.magnacard Estimate magnacard costs without sending. Risk: read
Input
Output

notecard

estimate.notecard Estimate notecard costs without sending. Risk: read
Input
Output

postcard

estimate.postcard Estimate postcard costs without sending. Risk: read
Input
Output

windowedLetter

estimate.windowedLetter Estimate windowed-letter costs without sending. Risk: read
Input
Output

windowlessLetter

estimate.windowlessLetter Estimate windowless-letter costs without sending. Risk: read
Input
Output

Giftcard Brands

list

giftcardBrands.list List gift-card brands by group. Risk: read
Input: empty object Output

listFlat

giftcardBrands.listFlat List gift-card brands with their groups. Risk: read
Input: empty object Output: object \| object[]

Handwriting Styles

list

handwritingStyles.list List handwriting styles. Risk: read
Input: empty object Output

Image Builder

create

imageBuilder.create Build and return a PNG image without placing an order. Risk: read
Input Output

Image Templates

list

imageTemplates.list List image templates. Risk: read
Input Output

Mailing Lists

buyRadiusSearch

mailingLists.buyRadiusSearch Purchase radius-search records; charges may apply. Risk: destructive
Input
Output

countRadiusSearch

mailingLists.countRadiusSearch Count available radius-search records. Risk: read
Input
Output

create

mailingLists.create Create a mailing list. Risk: write
Input
Output

delete

mailingLists.delete Delete a mailing list. Risk: destructive
Input Output: empty object

get

mailingLists.get Get a mailing list. Risk: read
Input Output

list

mailingLists.list List mailing lists. Risk: read
Input Output

listRecipients

mailingLists.listRecipients List recipients in a mailing list. Risk: read
Input Output

Message Templates

create

messageTemplates.create Create a message template. Risk: write
Input
Output

delete

messageTemplates.delete Delete a message template. Risk: destructive
Input Output

get

messageTemplates.get Get a message template. Risk: read
Input Output

list

messageTemplates.list List message templates. Risk: read
Input Output

update

messageTemplates.update Update a message template. Risk: write
Input
Output

Order Items

invalidateGiftcard

orderItems.invalidateGiftcard Permanently invalidate an unredeemed gift card. Risk: destructive · Irreversible
Input Output

Orders

cancel

orders.cancel Cancel a reviewing order. Risk: destructive
Input Output

list

orders.list List recent orders. Risk: read
Input Output

listItems

orders.listItems List individual order items. Risk: read
Input Output

replay

orders.replay Place a new copy of a settled order; this charges and mails again. Risk: destructive
Input
Output

track

orders.track Track an order and its delivery statistics. Risk: read
Input Output

Recipients

create

recipients.create Create a recipient; email-only address lookup may incur a fee. Risk: destructive
Input
Output

createMultiple

recipients.createMultiple Create recipients; email-only address lookup may incur a fee. Risk: destructive
Input
Output: object[]

delete

recipients.delete Delete a recipient by ID. Risk: destructive
Input Output: empty object

deleteByAddress

recipients.deleteByAddress Delete a recipient by address or email. Risk: destructive
Input
Output: empty object

get

recipients.get Get a recipient by ID. Risk: read
Input Output

update

recipients.update Update a recipient by ID. Risk: write
Input
Output

Send

giftcard

send.giftcard Send a gift card; charges may apply. Risk: destructive
Input
Output: object

magnacard

send.magnacard Send a magnacard; charges may apply. Risk: destructive
Input
Output: object

notecard

send.notecard Send a notecard; charges may apply. Risk: destructive
Input
Output: object

postcard

send.postcard Send a postcard; charges may apply. Risk: destructive
Input
Output: object

windowedLetter

send.windowedLetter Send a windowed letter; charges may apply. Risk: destructive
Input
Output: object

windowlessLetter

send.windowlessLetter Send a windowless letter; charges may apply. Risk: destructive
Input
Output: object

Sub Accounts

create

subAccounts.create Create a sub-account. Risk: write
Input
Output

delete

subAccounts.delete Delete a sub-account and its image templates, message templates, and campaigns; orders and lists move to the main account. Risk: destructive · Irreversible
Input Output: empty object

get

subAccounts.get Get a sub-account. Risk: read
Input Output

list

subAccounts.list List sub-accounts. Risk: read
Input: empty object Output

update

subAccounts.update Update a sub-account. Risk: write
Input
Output

Webhook Destinations

create

webhookDestinations.create Create an outbound webhook destination. Risk: write
Input
Output

delete

webhookDestinations.delete Delete an outbound webhook destination. Risk: destructive
Input Output

list

webhookDestinations.list List outbound webhook destinations. Risk: read
Input Output

update

webhookDestinations.update Update an outbound webhook destination. Risk: write
Input
Output