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

Account

balance

account.balance Get available SMS credits Risk: read
Input: empty object Output

changePassword

account.changePassword Change the account password Risk: write
Input Output

forgotPassword

account.forgotPassword Request a password reset (SMS Alert emails the account owner) Risk: destructive
Input Output

profile

account.profile Get the account profile Risk: read
Input: empty object Output

register

account.register Register an SMS Alert account (SMS Alert texts an OTP to the mobile number) Risk: destructive
Input Output

senders

account.senders List sender IDs Risk: read
Input: empty object Output

updateProfile

account.updateProfile Update the account profile Risk: write
Input Output

Contacts

create

contacts.create Create a contact Risk: write
Input Output

delete

contacts.delete Delete a contact Risk: destructive
Input Output

list

contacts.list List contacts in a group Risk: read
Input Output

update

contacts.update Update a contact Risk: write
Input Output

Groups

create

groups.create Create a contact group Risk: write
Input Output

delete

groups.delete Delete a contact group Risk: destructive
Input Output

list

groups.list List contact groups Risk: read
Input Output

send

groups.send Send SMS to contact groups Risk: destructive
Input Output

update

groups.update Update a contact group Risk: write
Input Output

Messages

send

messages.send Send or schedule an SMS, optionally requesting delivery callbacks Risk: destructive
Input Output

Otp

generate

otp.generate Generate and send an OTP Risk: destructive
Input Output

validate

otp.validate Validate an OTP Risk: write
Input Output

Reports

delivery

reports.delivery Get delivery reports for a batch Risk: read
Input Output

sent

reports.sent List sent SMS campaigns Risk: read
Input Output

Schedules

cancel

schedules.cancel Cancel a scheduled campaign Risk: destructive
Input Output

update

schedules.update Change a scheduled campaign Risk: write
Input Output

Short Urls

create

shortUrls.create Create a short URL Risk: write
Input Output

delete

shortUrls.delete Delete a short URL Risk: destructive
Input Output

Templates

create

templates.create Create an SMS template Risk: write
Input Output

delete

templates.delete Delete an SMS template Risk: destructive
Input Output

list

templates.list List SMS templates Risk: read
Input Output

update

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