New to Corsair? See API access, authentication, and error handling.
Account
balance
account.balance
Get available SMS credits
Risk: read
description full type
description full type
changePassword
account.changePassword
Change the account password
Risk: write
Output
forgotPassword
account.forgotPassword
Request a password reset (SMS Alert emails the account owner)
Risk: destructive
Output
profile
account.profile
Get the account profile
Risk: read
description full type
description full type
register
account.register
Register an SMS Alert account (SMS Alert texts an OTP to the mobile number)
Risk: destructive
Output
senders
account.senders
List sender IDs
Risk: read
description full type
description full type
updateProfile
account.updateProfile
Update the account profile
Risk: write
Output
Contacts
create
contacts.create
Create a contact
Risk: write
Output
delete
contacts.delete
Delete a contact
Risk: destructive
Output
list
contacts.list
List contacts in a group
Risk: read
Output
description full type
description full type
update
contacts.update
Update a contact
Risk: write
Output
Groups
create
groups.create
Create a contact group
Risk: write
Output
delete
groups.delete
Delete a contact group
Risk: destructive
Output
list
groups.list
List contact groups
Risk: read
Output
description full type
description full type
send
groups.send
Send SMS to contact groups
Risk: destructive
Output
description full type
description full type
update
groups.update
Update a contact group
Risk: write
Output
Messages
send
messages.send
Send or schedule an SMS, optionally requesting delivery callbacks
Risk: destructive
Output
description full type
description full type
Otp
generate
otp.generate
Generate and send an OTP
Risk: destructive
Output
description full type
description full type
validate
otp.validate
Validate an OTP
Risk: write
Output
description full type
description full type
Reports
delivery
reports.delivery
Get delivery reports for a batch
Risk: read
Output
description full type
description full type
sent
reports.sent
List sent SMS campaigns
Risk: read
Output
description full type
description full type
Schedules
cancel
schedules.cancel
Cancel a scheduled campaign
Risk: destructive
Output
update
schedules.update
Change a scheduled campaign
Risk: write
Output
Short Urls
create
shortUrls.create
Create a short URL
Risk: write
Output
description full type
description full type
delete
shortUrls.delete
Delete a short URL
Risk: destructive
Output
Templates
create
templates.create
Create an SMS template
Risk: write
Output
delete
templates.delete
Delete an SMS template
Risk: destructive
Output
list
templates.list
List SMS templates
Risk: read
Output
description full type
description full type
update
templates.update
Update an SMS template
Risk: write
Output