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

Account

get

account.get Retrieve ClickSend account details and credit balance Risk: read
Input: empty object Output

update

account.update Update ClickSend account profile fields Risk: write
Input Output

Campaigns

mms.cancel

campaigns.mms.cancel Cancel a scheduled MMS campaign Risk: write
Input Output: object \| never[] \| Record<string, string> \| boolean \| null

mms.list

campaigns.mms.list List MMS campaigns Risk: read
Input: empty object Output

mms.price

campaigns.mms.price Calculate the price of an MMS campaign Risk: write
Input Output

mms.send

campaigns.mms.send Create and send an MMS campaign to a contact list Risk: write
Input Output

mms.update

campaigns.mms.update Update a scheduled MMS campaign Risk: write
Input Output

sms.cancel

campaigns.sms.cancel Cancel a scheduled SMS campaign Risk: write
Input Output: object \| never[] \| Record<string, string> \| boolean \| null

sms.get

campaigns.sms.get Retrieve a single SMS campaign by ID Risk: read
Input Output

sms.list

campaigns.sms.list List SMS campaigns with pagination and filters Risk: read
Input Output

sms.price

campaigns.sms.price Calculate the price of an SMS campaign Risk: write
Input Output

sms.send

campaigns.sms.send Create and send an SMS campaign to a contact list Risk: write
Input Output

sms.update

campaigns.sms.update Update a scheduled SMS campaign Risk: write
Input Output

Contact Lists

create

contactLists.create Create a new contact list Risk: write
Input Output

delete

contactLists.delete Delete a contact list by ID Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

contactLists.get Retrieve a single contact list by ID Risk: read
Input Output

getAll

contactLists.getAll Retrieve all contact lists with pagination Risk: read
Input Output

update

contactLists.update Rename a contact list by ID Risk: write
Input Output

Contacts

copy

contacts.copy Copy a contact from one list to another Risk: write
Input Output

create

contacts.create Add a new contact to a specific list Risk: write
Input Output

delete

contacts.delete Delete a contact from a list Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

contacts.get Retrieve a single contact from a list Risk: read
Input Output

import

contacts.import Bulk-import contacts into a list from a file URL Risk: write
Input Output

importFields

contacts.importFields List valid import field mappings for a list Risk: read
Input Output: object[]

importPreview

contacts.importPreview Preview the first row of a CSV import file Risk: write
Input Output

list

contacts.list List contacts within a specific contact list Risk: read
Input Output

removeOptedOut

contacts.removeOptedOut Remove opted-out contacts from a list Risk: write
Input Output
contacts.search Search contact lists and contacts by keyword Risk: read
Input Output

suggestions

contacts.suggestions List suggested contacts across lists Risk: read
Input: empty object Output: object[]

transfer

contacts.transfer Move a contact from one list to another Risk: write
Input Output

update

contacts.update Update contact fields within a list Risk: write
Input Output

Countries

globalList

countries.globalList List global sending destination countries Risk: read
Input: empty object Output: object[]

list

countries.list List supported countries as code/value pairs Risk: read
Input: empty object Output: object[]

pricing

countries.pricing Retrieve per-country pricing for a currency Risk: read
Input Output

userCountriesAgree

countries.userCountriesAgree Agree to sending-country compliance rules Risk: write
Input: empty object Output: object[]

userCountriesGet

countries.userCountriesGet List enabled global-sending countries Risk: read
Input: empty object Output: object[]

userCountriesSelect

countries.userCountriesSelect Select enabled global-sending countries Risk: write
Input Output: object[]

Delivery Issues

create

deliveryIssues.create Report a message delivery issue Risk: write
Input Output

list

deliveryIssues.list List delivery issues with pagination Risk: read
Input Output

Email Addresses

create

emailAddresses.create Register a new allowed sender email address Risk: write
Input Output

delete

emailAddresses.delete Delete an allowed email address by ID Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

emailAddresses.get Retrieve a single allowed email address by ID Risk: read
Input Output

list

emailAddresses.list List allowed sender email addresses Risk: read
Input Output

sendToken

emailAddresses.sendToken Send a verification token to an allowed email address Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

verify

emailAddresses.verify Verify an allowed email address with its activation token Risk: write
Input Output

Email Campaigns

get

emailCampaigns.get Retrieve a single email campaign by ID Risk: read
Input Output

Email Master Categories

get

emailMasterCategories.get Retrieve a single master template category by ID Risk: read
Input Output

list

emailMasterCategories.list List master email template categories Risk: read
Input Output: object[]

Email Master Templates

get

emailMasterTemplates.get Retrieve a single master email template by ID Risk: read
Input Output

list

emailMasterTemplates.list List ClickSend master email templates Risk: read
Input Output

listInCategory

emailMasterTemplates.listInCategory List master email templates within a category Risk: read
Input Output

Email Receipt Rules

create

emailReceiptRules.create Create an email delivery receipt automation rule Risk: write
Input Output

delete

emailReceiptRules.delete Delete an email delivery receipt automation rule Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

emailReceiptRules.get Retrieve a single email receipt automation rule Risk: read
Input Output

list

emailReceiptRules.list List email delivery receipt automation rules Risk: read
Input Output

update

emailReceiptRules.update Update an email delivery receipt automation rule Risk: write
Input Output

Email Templates

create

emailTemplates.create Create a user email template from a master template Risk: write
Input Output

delete

emailTemplates.delete Delete a user email template by ID Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

emailTemplates.get Retrieve a single user email template by ID Risk: read
Input Output

list

emailTemplates.list List user email templates Risk: read
Input Output

update

emailTemplates.update Update a user email template Risk: write
Input Output

Fax Inbound Rules

create

faxInboundRules.create Create a fax inbound automation rule Risk: write
Input Output

delete

faxInboundRules.delete Delete a fax inbound automation rule Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

faxInboundRules.get Retrieve a single fax inbound automation rule Risk: read
Input Output

list

faxInboundRules.list List fax inbound automation rules Risk: read
Input Output

update

faxInboundRules.update Update a fax inbound automation rule Risk: write
Input Output

Fax Receipt Rules

create

faxReceiptRules.create Create a fax receipt automation rule Risk: write
Input Output

delete

faxReceiptRules.delete Delete a fax receipt automation rule Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

faxReceiptRules.get Retrieve a single fax receipt automation rule Risk: read
Input Output

list

faxReceiptRules.list List fax receipt automation rules Risk: read
Input Output

update

faxReceiptRules.update Update a fax receipt automation rule Risk: write
Input Output

Fax Receipts

createTest

faxReceipts.createTest Create a test fax delivery receipt for a callback URL Risk: write
Input Output

get

faxReceipts.get Retrieve a single fax receipt by message ID Risk: read
Input Output

list

faxReceipts.list List fax delivery receipts with pagination Risk: read
Input Output

markRead

faxReceipts.markRead Mark fax delivery receipts as read Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

Mms

history

mms.history List MMS message history with pagination Risk: read
Input Output

historyExport

mms.historyExport Export MMS history to a downloadable file Risk: read
Input Output

price

mms.price Calculate the price of MMS messages without sending Risk: write
Input
Output

receipts

mms.receipts List MMS delivery receipts with pagination Risk: read
Input Output

receiptsMarkRead

mms.receiptsMarkRead Mark MMS delivery receipts as read Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

send

mms.send Send one or more MMS messages with media Risk: write
Input
Output

Numbers

buy

numbers.buy Purchase a dedicated number Risk: write
Input Output

list

numbers.list List owned dedicated numbers Risk: read
Input Output

search

numbers.search Search available dedicated numbers by country Risk: read
Input Output

Post Direct Mail

searchLocations

postDirectMail.searchLocations Search direct mail delivery locations by country Risk: read
Input Output

send

postDirectMail.send Send a direct mail campaign Risk: write
Input
Output: empty object

Post Letters

detectAddress

postLetters.detectAddress Detect a structured address from PDF content or text Risk: write
Input Output

history

postLetters.history List post letter history with pagination Risk: read
Input Output

historyExport

postLetters.historyExport Export post letter history to a downloadable file Risk: read
Input Output

price

postLetters.price Calculate post letter price without sending Risk: write
Input
Output

send

postLetters.send Send a physical post letter to recipients Risk: write
Input
Output

Post Return Addresses

create

postReturnAddresses.create Create a post return address Risk: write
Input Output

delete

postReturnAddresses.delete Delete a post return address by ID Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

postReturnAddresses.get Retrieve a single post return address by ID Risk: read
Input Output

list

postReturnAddresses.list List post return addresses with pagination Risk: read
Input Output

update

postReturnAddresses.update Update a post return address by ID Risk: write
Input Output

Recharge

creditCardGet

recharge.creditCardGet Retrieve the stored recharge credit card Risk: read
Input: empty object Output

creditCardUpdate

recharge.creditCardUpdate Replace the stored recharge credit card Risk: write
Input Output

packages

recharge.packages List available recharge packages and currency Risk: read
Input: empty object Output

purchase

recharge.purchase Purchase a recharge package by ID Risk: write
Input Output

transactionGet

recharge.transactionGet Retrieve a single recharge transaction Risk: read
Input Output

transactions

recharge.transactions List recharge transactions with pagination Risk: read
Input Output

Referral

accountsList

referral.accountsList List referral accounts Risk: read
Input: empty object Output

Reseller

accountsList

reseller.accountsList List reseller child accounts Risk: read
Input Output

settingsGet

reseller.settingsGet Retrieve reseller settings Risk: read
Input: empty object Output: empty object

settingsUpdate

reseller.settingsUpdate Update reseller settings Risk: write
Input Output: empty object

Sms

cancel

sms.cancel Cancel a scheduled SMS message Risk: write
Input Output

cancelAll

sms.cancelAll Cancel all scheduled SMS messages Risk: write
Input Output

history

sms.history List sent SMS message history with pagination Risk: read
Input Output

historyExport

sms.historyExport Export SMS history to a downloadable file Risk: read
Input Output

inbound

sms.inbound List received inbound SMS messages with pagination Risk: read
Input Output

inboundCreateTest

sms.inboundCreateTest Create a test inbound SMS message Risk: write
Input Output

inboundMarkRead

sms.inboundMarkRead Mark inbound SMS messages as read Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

inboundMarkReadOne

sms.inboundMarkReadOne Mark a single inbound SMS message as read Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

price

sms.price Calculate the price of SMS messages without sending Risk: write
Input
Output

receiptCreateTest

sms.receiptCreateTest Create a test SMS delivery receipt for a webhook URL Risk: write
Input Output

receiptGet

sms.receiptGet Retrieve a single SMS delivery receipt by message ID Risk: read
Input Output

receipts

sms.receipts List SMS delivery receipts with pagination Risk: read
Input Output

receiptsMarkRead

sms.receiptsMarkRead Mark SMS delivery receipts as read Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

send

sms.send Send one or more SMS messages Risk: write
Input
Output

statistics

sms.statistics Retrieve SMS usage statistics Risk: read
Input: empty object Output

Sms Email Sms

create

smsEmailSms.create Allow an email address for email-to-SMS Risk: write
Input Output

list

smsEmailSms.list List allowed email-to-SMS addresses Risk: read
Input Output

Sms Inbound Rules

create

smsInboundRules.create Create an SMS inbound automation rule Risk: write
Input Output

delete

smsInboundRules.delete Delete an SMS inbound automation rule Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

smsInboundRules.get Retrieve an SMS inbound automation rule Risk: read
Input Output

list

smsInboundRules.list List SMS inbound automation rules Risk: read
Input Output

update

smsInboundRules.update Update an SMS inbound automation rule Risk: write
Input Output

Sms Receipt Rules

create

smsReceiptRules.create Create an SMS receipt automation rule Risk: write
Input Output

delete

smsReceiptRules.delete Delete an SMS receipt automation rule Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

smsReceiptRules.get Retrieve an SMS receipt automation rule Risk: read
Input Output

list

smsReceiptRules.list List SMS receipt automation rules Risk: read
Input Output

update

smsReceiptRules.update Update an SMS receipt automation rule Risk: write
Input Output

Sms Stripped Strings

create

smsStrippedStrings.create Create an email-to-SMS stripped-string rule Risk: write
Input Output

delete

smsStrippedStrings.delete Delete an email-to-SMS stripped-string rule Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

smsStrippedStrings.get Retrieve a single stripped-string rule Risk: read
Input Output

list

smsStrippedStrings.list List email-to-SMS stripped-string rules Risk: read
Input: empty object Output

update

smsStrippedStrings.update Update an email-to-SMS stripped-string rule Risk: write
Input Output

Sms Templates

create

smsTemplates.create Create an SMS message template Risk: write
Input Output

delete

smsTemplates.delete Delete an SMS template Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

smsTemplates.get Retrieve a single SMS template Risk: read
Input Output

list

smsTemplates.list List SMS templates with pagination Risk: read
Input Output

update

smsTemplates.update Update an SMS template Risk: write
Input Output

Subaccounts

create

subaccounts.create Create a new subaccount Risk: write
Input Output

delete

subaccounts.delete Delete a subaccount Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

subaccounts.get Retrieve a single subaccount Risk: read
Input Output

list

subaccounts.list List subaccounts with pagination Risk: read
Input Output

regenKey

subaccounts.regenKey Regenerate a subaccount API key Risk: write
Input Output

update

subaccounts.update Update subaccount contact fields Risk: write
Input Output

Timezones

list

timezones.list List supported timezone names Risk: read
Input: empty object Output: string[]

Uploads

upload

uploads.upload Upload and convert a file for messaging services Risk: write
Input Output

uploadDocument

uploads.uploadDocument Upload a document for fax and post services Risk: write
Input Output

Voice

cancelAll

voice.cancelAll Cancel all scheduled voice calls Risk: write
Input: empty object Output

history

voice.history List voice call history with pagination Risk: read
Input Output

historyExport

voice.historyExport Export voice history to a downloadable file Risk: read
Input Output

languages

voice.languages List available voice-call languages Risk: read
Input: empty object Output: object[]

receiptsMarkRead

voice.receiptsMarkRead Mark voice delivery receipts as read Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

send

voice.send Initiate outbound text-to-speech voice call Risk: write
Input
Output

statistics

voice.statistics Retrieve voice usage statistics Risk: read
Input: empty object Output

Voice Receipt Rules

create

voiceReceiptRules.create Create a voice receipt automation rule Risk: write
Input Output

delete

voiceReceiptRules.delete Delete a voice receipt automation rule Risk: write
Input Output: never[] \| Record<string, string> \| boolean \| null

get

voiceReceiptRules.get Retrieve a voice receipt automation rule Risk: read
Input Output

list

voiceReceiptRules.list List voice receipt automation rules Risk: read
Input Output

update

voiceReceiptRules.update Update a voice receipt automation rule Risk: write
Input Output