New to Corsair? See API access, authentication, and error handling.
Account
generateApiToken
account.generateApiToken
Generate a bearer token for the eSputnik event endpoints (returns a secret)
Risk: write
JsonValue
getAccountInfo
account.getAccountInfo
Get the eSputnik account name and organisation ID
Risk: read
getBalance
account.getBalance
Get the eSputnik organisation balance
Risk: read
getOrganisationBalanceHistory
account.getOrganisationBalanceHistory
Get daily eSputnik billing costs for a period of up to 90 days
Risk: read
Output:
Record<string, JsonValue>
App Inbox
addAppInboxMessage
appInbox.addAppInboxMessage
Create a eSputnik App Inbox message
Risk: write
Record<string, any>
Output
deleteAppInboxMessage
appInbox.deleteAppInboxMessage
Delete a eSputnik App Inbox message
Risk: destructive
Output:
JsonValue
deleteTranslatedAppInboxMessage
appInbox.deleteTranslatedAppInboxMessage
Delete a language version of a eSputnik App Inbox message
Risk: destructive
Output:
JsonValue
getAppInboxMessage
appInbox.getAppInboxMessage
Get a eSputnik App Inbox message with its language versions
Risk: read
Output:
Record<string, JsonValue>
searchAppInboxMessages
appInbox.searchAppInboxMessages
Search eSputnik App Inbox messages by name
Risk: read
Output:
JsonValue[]
updateBaseAppInboxMessage
appInbox.updateBaseAppInboxMessage
Update a eSputnik App Inbox message
Risk: write
object
Input full type
Input full type
JsonValue
updateTranslatedAppInboxMessage
appInbox.updateTranslatedAppInboxMessage
Add or update a language version of a eSputnik App Inbox message
Risk: write
object
Input full type
Input full type
JsonValue
Apps
addAppTokens
apps.addAppTokens
Add Telegram application tokens to eSputnik
Risk: write
tokens full type
tokens full type
JsonValue
muteAppToken
apps.muteAppToken
Mute eSputnik notifications for an application token
Risk: write
Output:
JsonValue
unmuteAppToken
apps.unmuteAppToken
Unmute eSputnik notifications for an application token
Risk: write
Output:
JsonValue
Broadcasts
cancelBroadcast
broadcasts.cancelBroadcast
Cancel a scheduled eSputnik broadcast
Risk: destructive
Output:
JsonValue
createBroadcast
broadcasts.createBroadcast
Create an eSputnik broadcast for a prepared message and segments
Risk: write
Output:
Record<string, JsonValue>
getBroadcast
broadcasts.getBroadcast
Get an eSputnik broadcast
Risk: read
Output:
Record<string, JsonValue>
getBroadcasts
broadcasts.getBroadcasts
List eSputnik broadcasts
Risk: read
Output:
JsonValue[]
Contacts
addContact
contacts.addContact
Create or update an eSputnik contact
Risk: write
channels full type
channels full type
address full type
address full type
fields full type
fields full type
addToUnsubscribed
contacts.addToUnsubscribed
Add emails to the eSputnik unsubscribe list
Risk: write
Output:
JsonValue
attachContactsToGroup
contacts.attachContactsToGroup
Add contacts to an eSputnik static segment
Risk: write
Output:
JsonValue
changeContactSubscriptionCategories
contacts.changeContactSubscriptionCategories
Replace an eSputnik contact’s subscription categories
Risk: write
Output:
JsonValue
changeTokenActivated
contacts.changeTokenActivated
Activate or deactivate an eSputnik mobile push token
Risk: write
Output
contactActivity
contacts.contactActivity
Get delivery, read and click activity for messages sent to eSputnik contacts
Risk: read
Output:
JsonValue[]
contactMessages
contacts.contactMessages
Get an eSputnik contact’s message history
Risk: read
Output:
JsonValue[]
contactRecoms
contacts.contactRecoms
Get product recommendations for an eSputnik contact
Risk: read
Output:
JsonValue[]
contactsBulkUpdate
contacts.contactsBulkUpdate
Bulk create or update eSputnik contacts
Risk: write
Record<string, any>
Output: Record<string, JsonValue>
deleteContactByExternalCustomerId
contacts.deleteContactByExternalCustomerId
Delete an eSputnik contact by external customer ID
Risk: destructive
Output:
JsonValue
deleteContactById
contacts.deleteContactById
Delete an eSputnik contact by ID
Risk: destructive
Output:
JsonValue
deleteFromUnsubscribed
contacts.deleteFromUnsubscribed
Remove emails from the eSputnik unsubscribe list
Risk: destructive
Output:
JsonValue
detachContactsFromGroup
contacts.detachContactsFromGroup
Remove contacts from an eSputnik static segment
Risk: destructive
Output:
JsonValue
fileContactsBulkUpdate
contacts.fileContactsBulkUpdate
Import eSputnik contacts from a file link
Risk: write
Record<string, any>
Output: Record<string, JsonValue>
getAdditionalFields
contacts.getAdditionalFields
List eSputnik contact additional fields
Risk: read
Record<string, JsonValue>
getContact
contacts.getContact
Get an eSputnik contact by ID
Risk: read
Output
getContactEmails
contacts.getContactEmails
Get email addresses for eSputnik contact IDs
Risk: read
Output
getContactIdByToken
contacts.getContactIdByToken
Get an eSputnik contact ID by mobile push token
Risk: read
Output
getContactSubscriptionCategories
contacts.getContactSubscriptionCategories
Get an eSputnik contact’s subscription categories
Risk: read
Output:
JsonValue[]
getGroupContacts
contacts.getGroupContacts
Get contacts in an eSputnik segment
Risk: read
Output:
JsonValue[]
getImportSessionStatus
contacts.getImportSessionStatus
Get eSputnik contact import status
Risk: read
Output:
Record<string, JsonValue>
getSubscriptionCategories
contacts.getSubscriptionCategories
List the organisation’s eSputnik subscription categories
Risk: read
JsonValue[]
getTokenActivated
contacts.getTokenActivated
Get whether an eSputnik mobile push token is active
Risk: read
Output
searchContacts
contacts.searchContacts
Search eSputnik contacts (up to 500 per page)
Risk: read
Output:
object[]
Output full type
Output full type
searchGroups
contacts.searchGroups
Search eSputnik segments
Risk: read
Output:
JsonValue[]
searchWorkflows
contacts.searchWorkflows
Search eSputnik workflows
Risk: read
Output:
JsonValue[]
subscribeContact
contacts.subscribeContact
Subscribe an eSputnik contact
Risk: write
contact full type
contact full type
updateContact
contacts.updateContact
Update an eSputnik contact by ID
Risk: write
object
Input full type
Input full type
JsonValue
Emails
addEmail
emails.addEmail
Create an eSputnik email message
Risk: write
Output
deleteEmail
emails.deleteEmail
Delete an eSputnik email message
Risk: destructive
Output:
JsonValue
deleteTranslatedEmail
emails.deleteTranslatedEmail
Delete a language version of an eSputnik email message
Risk: destructive
Output:
JsonValue
getEmail
emails.getEmail
Get an eSputnik email message
Risk: read
Output:
Record<string, JsonValue>
getEmailMessageViewLink
emails.getEmailMessageViewLink
Get a link to view an eSputnik email message
Risk: read
Output:
Record<string, JsonValue>
searchEmails
emails.searchEmails
Search eSputnik email messages by name or tag
Risk: read
Output:
JsonValue[]
sendEmail
emails.sendEmail
Send an email to eSputnik recipients
Risk: write
Record<string, any>
Output
updateMessage
emails.updateMessage
Update an eSputnik email message
Risk: write
object
Input full type
Input full type
JsonValue
updateTranslatedMessage
emails.updateTranslatedMessage
Add or update a language version of an eSputnik email message
Risk: write
object
Input full type
Input full type
JsonValue
Events
registerEvent
events.registerEvent
Send an eSputnik event
Risk: write
Record<string, any>
Output: JsonValue
removeHistoryEvents
events.removeHistoryEvents
Delete eSputnik events in a period
Risk: destructive
Record<string, any>
Output: JsonValue
sendHistoryEvents
events.sendHistoryEvents
Send past eSputnik events
Risk: write
Record<string, any>
Output: Record<string, JsonValue>
Interfaces
getEmailInterfaces
interfaces.getEmailInterfaces
List eSputnik email sender addresses
Risk: read
JsonValue[]
getSmsInterfaces
interfaces.getSmsInterfaces
List eSputnik SMS sender names
Risk: read
JsonValue[]
Messages
sendPreparedMessage
messages.sendPreparedMessage
Send a prepared eSputnik message to one or more contacts
Risk: write
recipients full type
recipients full type
updateInteractionStatus
messages.updateInteractionStatus
Report a delivery, open or click status for an eSputnik message interaction
Risk: write
Output:
JsonValue
Mobile Push
addMobilePushMessage
mobilePush.addMobilePushMessage
Create a eSputnik mobile push message
Risk: write
Output
deleteMobilePushMessage
mobilePush.deleteMobilePushMessage
Delete a eSputnik mobile push message
Risk: destructive
Output:
JsonValue
deleteTranslatedMobilePushMessage
mobilePush.deleteTranslatedMobilePushMessage
Delete a language version of a eSputnik mobile push message
Risk: destructive
Output:
JsonValue
getMobilePushMessage
mobilePush.getMobilePushMessage
Get a eSputnik mobile push message with its language versions
Risk: read
Output:
Record<string, JsonValue>
searchMobilePushMessages
mobilePush.searchMobilePushMessages
Search eSputnik mobile push messages by name
Risk: read
Output:
JsonValue[]
updateBaseMobilePushMessage
mobilePush.updateBaseMobilePushMessage
Update a eSputnik mobile push message
Risk: write
object
Input full type
Input full type
JsonValue
updateTranslatedMobilePushMessage
mobilePush.updateTranslatedMobilePushMessage
Add or update a language version of a eSputnik mobile push message
Risk: write
object
Input full type
Input full type
JsonValue
Orders
ordersBulkInsert
orders.ordersBulkInsert
Add or update eSputnik orders
Risk: write
Record<string, any>
Output: Record<string, JsonValue>
Preprocessor
getPreprocessorFileStatus
preprocessor.getPreprocessorFileStatus
Get the status of an eSputnik preprocessor file upload
Risk: read
Output:
JsonValue
updatePreprocessorFile
preprocessor.updatePreprocessorFile
Replace the data of an eSputnik preprocessor file
Risk: destructive
Output:
Record<string, JsonValue>
uploadPreprocessorFile
preprocessor.uploadPreprocessorFile
Upload an eSputnik preprocessor file from a link
Risk: write
Output:
Record<string, JsonValue>
Product Feeds
configureProductFeeds
productFeeds.configureProductFeeds
Configure eSputnik product feeds
Risk: write
feeds full type
feeds full type
JsonValue
getProductFeedsConfiguration
productFeeds.getProductFeedsConfiguration
Get eSputnik product feed configuration
Risk: read
Record<string, JsonValue>
Promocodes
getPromocodes
promocodes.getPromocodes
Get available eSputnik promotional codes
Risk: read
Output:
JsonValue
getPromocodesCount
promocodes.getPromocodesCount
Count available eSputnik promotional codes
Risk: read
Output:
JsonValue
insertPromocodes
promocodes.insertPromocodes
Upload eSputnik promotional codes
Risk: write
Output:
JsonValue
Site
addWebPushDomain
site.addWebPushDomain
Register an eSputnik web push domain
Risk: write
Output:
Record<string, JsonValue>
createDomain
site.createDomain
Register a domain for eSputnik web tracking
Risk: write
Output:
Record<string, JsonValue>
deleteWebPushDomain
site.deleteWebPushDomain
Delete an eSputnik web push domain
Risk: destructive
Output:
JsonValue
getDomains
site.getDomains
Get the organisation’s eSputnik web tracking domain
Risk: read
JsonValue[]
getScript
site.getScript
Get the eSputnik web tracking script
Risk: read
string
getWebPushDomains
site.getWebPushDomains
List eSputnik web push domains
Risk: read
Record<string, JsonValue>
getWebPushScript
site.getWebPushScript
Get the eSputnik web push script for a domain
Risk: read
Output:
Record<string, JsonValue>
Sms
addSmsMessage
sms.addSmsMessage
Create a eSputnik SMS message
Risk: write
Record<string, any>
Output
deleteSmsMessage
sms.deleteSmsMessage
Delete a eSputnik SMS message
Risk: destructive
Output:
JsonValue
deleteTranslatedSmsMessage
sms.deleteTranslatedSmsMessage
Delete a language version of a eSputnik SMS message
Risk: destructive
Output:
JsonValue
getSms
sms.getSms
Get a eSputnik SMS message with its language versions
Risk: read
Output:
Record<string, JsonValue>
searchSmsMessages
sms.searchSmsMessages
Search eSputnik SMS messages by name
Risk: read
Output:
JsonValue[]
sendSms
sms.sendSms
Send an SMS to eSputnik recipients
Risk: write
Record<string, any>
Output
updateBaseSmsMessage
sms.updateBaseSmsMessage
Update a eSputnik SMS message
Risk: write
object
Input full type
Input full type
JsonValue
updateTranslatedSmsMessage
sms.updateTranslatedSmsMessage
Add or update a language version of a eSputnik SMS message
Risk: write
object
Input full type
Input full type
JsonValue
Telegram Bot
addTelegramBotMessage
telegramBot.addTelegramBotMessage
Create a eSputnik Telegram bot message
Risk: write
Record<string, any>
Output
deleteTelegramBotMessage
telegramBot.deleteTelegramBotMessage
Delete a eSputnik Telegram bot message
Risk: destructive
Output:
JsonValue
deleteTranslatedTelegramMessage
telegramBot.deleteTranslatedTelegramMessage
Delete a language version of a eSputnik Telegram bot message
Risk: destructive
Output:
JsonValue
getTelegramBotMessage
telegramBot.getTelegramBotMessage
Get a eSputnik Telegram bot message with its language versions
Risk: read
Output:
Record<string, JsonValue>
searchTelegramBotMessages
telegramBot.searchTelegramBotMessages
Search eSputnik Telegram bot messages by name
Risk: read
Output:
JsonValue[]
updateBaseTelegramBotMessage
telegramBot.updateBaseTelegramBotMessage
Update a eSputnik Telegram bot message
Risk: write
object
Input full type
Input full type
JsonValue
updateTranslatedTelegramMessage
telegramBot.updateTranslatedTelegramMessage
Add or update a language version of a eSputnik Telegram bot message
Risk: write
object
Input full type
Input full type
JsonValue
Viber
addViberMessage
viber.addViberMessage
Create a eSputnik Viber message
Risk: write
Record<string, any>
Output
deleteTranslatedViberMessage
viber.deleteTranslatedViberMessage
Delete a language version of a eSputnik Viber message
Risk: destructive
Output:
JsonValue
deleteViberMessage
viber.deleteViberMessage
Delete a eSputnik Viber message
Risk: destructive
Output:
JsonValue
getViberMessage
viber.getViberMessage
Get a eSputnik Viber message with its language versions
Risk: read
Output:
Record<string, JsonValue>
searchViberMessages
viber.searchViberMessages
Search eSputnik Viber messages by name
Risk: read
Output:
JsonValue[]
sendViber
viber.sendViber
Send a Viber message to eSputnik recipients
Risk: write
Record<string, any>
Output
updateBaseViberMessage
viber.updateBaseViberMessage
Update a eSputnik Viber message
Risk: write
object
Input full type
Input full type
JsonValue
updateTranslatedViberMessage
viber.updateTranslatedViberMessage
Add or update a language version of a eSputnik Viber message
Risk: write
object
Input full type
Input full type
JsonValue