API - Corsair

Every esputnik.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

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

await corsair.esputnik.api.account.generateApiToken({});

Input: empty object Output: lazy

getAccountInfo

account.getAccountInfo Get the eSputnik account name and organisation ID Risk: read

await corsair.esputnik.api.account.getAccountInfo({});

Input: empty object Output

Name	Type	Required	Description
`orgId`	`number`	No	—
`userEmail`	`string`	No	—
`organisationName`	`string`	No	—

getBalance

account.getBalance Get the eSputnik organisation balance Risk: read

await corsair.esputnik.api.account.getBalance({});

Input: empty object Output

Name	Type	Required	Description
`currentBalance`	`number`	No	—
`creditLimit`	`number`	No	—
`currency`	`string`	No	—

getOrganisationBalanceHistory

account.getOrganisationBalanceHistory Get daily eSputnik billing costs for a period of up to 90 days Risk: read

await corsair.esputnik.api.account.getOrganisationBalanceHistory({});

Input

Name	Type	Required	Description
`dateFrom`	`string`	No	—
`dateTo`	`string`	No	—

Output: object

Output full type

{
}

App Inbox

addAppInboxMessage

appInbox.addAppInboxMessage Create a eSputnik App Inbox message Risk: write

await corsair.esputnik.api.appInbox.addAppInboxMessage({});

Input: object

Input full type

{
}

Output

Name	Type	Required	Description
`id`	`number`	Yes	—

deleteAppInboxMessage

appInbox.deleteAppInboxMessage Delete a eSputnik App Inbox message Risk: destructive

await corsair.esputnik.api.appInbox.deleteAppInboxMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: lazy

deleteTranslatedAppInboxMessage

appInbox.deleteTranslatedAppInboxMessage Delete a language version of a eSputnik App Inbox message Risk: destructive

await corsair.esputnik.api.appInbox.deleteTranslatedAppInboxMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`language`	`string`	Yes	—

Output: lazy

getAppInboxMessage

appInbox.getAppInboxMessage Get a eSputnik App Inbox message with its language versions Risk: read

await corsair.esputnik.api.appInbox.getAppInboxMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: object

Output full type

{
}

searchAppInboxMessages

appInbox.searchAppInboxMessages Search eSputnik App Inbox messages by name Risk: read

await corsair.esputnik.api.appInbox.searchAppInboxMessages({});

Input

Name	Type	Required	Description
`startindex`	`number`	No	—
`maxrows`	`number`	No	—
`search`	`string`	No	—

Output: lazy[]

updateBaseAppInboxMessage

appInbox.updateBaseAppInboxMessage Update a eSputnik App Inbox message Risk: write

await corsair.esputnik.api.appInbox.updateBaseAppInboxMessage({});

Input: object

Input full type

{
  id: number
}& {
}

Output: lazy

updateTranslatedAppInboxMessage

appInbox.updateTranslatedAppInboxMessage Add or update a language version of a eSputnik App Inbox message Risk: write

await corsair.esputnik.api.appInbox.updateTranslatedAppInboxMessage({});

Input: object

Input full type

{
  id: number,
  language: string
}& {
}

Output: lazy

Apps

addAppTokens

apps.addAppTokens Add Telegram application tokens to eSputnik Risk: write

await corsair.esputnik.api.apps.addAppTokens({});

Input

Name	Type	Required	Description
`app_uuid`	`string`	Yes	—
`tokens`	`object[]`	Yes	—

tokens full type

{
  token: string,
  contactId?: number,
  externalCustomerId?: string,
  phone?: string,
  email?: string
}[]

Output: lazy

muteAppToken

apps.muteAppToken Mute eSputnik notifications for an application token Risk: write

await corsair.esputnik.api.apps.muteAppToken({});

Input

Name	Type	Required	Description
`app_uuid`	`string`	Yes	—
`token`	`string`	Yes	—
`duration`	`number`	No	—

Output: lazy

unmuteAppToken

apps.unmuteAppToken Unmute eSputnik notifications for an application token Risk: write

await corsair.esputnik.api.apps.unmuteAppToken({});

Input

Name	Type	Required	Description
`app_uuid`	`string`	Yes	—
`token`	`string`	Yes	—

Output: lazy

Broadcasts

cancelBroadcast

broadcasts.cancelBroadcast Cancel a scheduled eSputnik broadcast Risk: destructive

await corsair.esputnik.api.broadcasts.cancelBroadcast({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—

Output: lazy

createBroadcast

broadcasts.createBroadcast Create an eSputnik broadcast for a prepared message and segments Risk: write

await corsair.esputnik.api.broadcasts.createBroadcast({ messageId: '4512', groups: [200400], startDate: '2026-11-10T09:00' });

Input

Name	Type	Required	Description
`title`	`string`	No	—
`messageId`	`string`	Yes	—
`groups`	`number[]`	Yes	—
`excludedGroups`	`number[]`	No	—
`startDate`	`string`	No	—
`batchSize`	`number`	No	—
`batchIntervalUnit`	`MINUTE \| HOUR \| DAY \| MONTH`	No	—
`domain`	`string`	No	—
`appId`	`string`	No	—

Output: object

Output full type

{
}

getBroadcast

broadcasts.getBroadcast Get an eSputnik broadcast Risk: read

await corsair.esputnik.api.broadcasts.getBroadcast({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—

Output: object

Output full type

{
}

getBroadcasts

broadcasts.getBroadcasts List eSputnik broadcasts Risk: read

await corsair.esputnik.api.broadcasts.getBroadcasts({});

Input

Name	Type	Required	Description
`startindex`	`number`	No	—
`maxrows`	`number`	No	—

Output: lazy[]

Contacts

addContact

contacts.addContact Create or update an eSputnik contact Risk: write

await corsair.esputnik.api.contacts.addContact({ firstName: 'Ada', channels: [{ type: 'email', value: 'ada@example.com' }], fields: [{ id: 79814, value: 'gold' }] });

Input

Name	Type	Required	Description
`id`	`number`	No	—
`firstName`	`string`	No	—
`lastName`	`string`	No	—
`channels`	`object[]`	Yes	—
`address`	`object`	No	—
`fields`	`object[]`	No	—
`addressBookId`	`number`	No	—
`externalCustomerId`	`string`	No	—
`languageCode`	`string`	No	—
`timeZone`	`string`	No	—
`marketId`	`string`	No	—

channels full type

{
  type: string,
  value: string,
  device?: {
  },
  webPushSubscription?: {
  }
}[]

address full type

{
  region?: string,
  town?: string,
  address?: string,
  postcode?: string,
  countryCode?: string | null
}

fields full type

{
  id: number,
  value: string
}[]

Output

Name	Type	Required	Description
`id`	`number`	Yes	—

addToUnsubscribed

contacts.addToUnsubscribed Add emails to the eSputnik unsubscribe list Risk: write

await corsair.esputnik.api.contacts.addToUnsubscribed({});

Input

Name	Type	Required	Description
`emails`	`string[]`	Yes	—

Output: lazy

attachContactsToGroup

contacts.attachContactsToGroup Add contacts to an eSputnik static segment Risk: write

await corsair.esputnik.api.contacts.attachContactsToGroup({ id: 200400, contactIds: [12345] });

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`contactIds`	`number[]`	No	—
`externalCustomerIds`	`string[]`	No	—

Output: lazy

changeContactSubscriptionCategories

contacts.changeContactSubscriptionCategories Replace an eSputnik contact’s subscription categories Risk: write

await corsair.esputnik.api.contacts.changeContactSubscriptionCategories({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`subscriptions`	`string[]`	Yes	—

Output: lazy

changeTokenActivated

contacts.changeTokenActivated Activate or deactivate an eSputnik mobile push token Risk: write

await corsair.esputnik.api.contacts.changeTokenActivated({});

Input

Name	Type	Required	Description
`app_uuid`	`string`	Yes	—
`token_id`	`string`	Yes	—
`active`	`boolean`	Yes	—

Output

Name	Type	Required	Description
`active`	`boolean`	Yes	—

contactActivity

contacts.contactActivity Get delivery, read and click activity for messages sent to eSputnik contacts Risk: read

await corsair.esputnik.api.contacts.contactActivity({ dateFrom: '2026-10-01', dateTo: '2026-10-31T23:59:59', email: 'ada@example.com', activityStatus: 'CLICKED' });

Input

Name	Type	Required	Description
`dateFrom`	`string`	Yes	—
`dateTo`	`string`	Yes	—
`email`	`string`	No	—
`sms`	`string`	No	—
`webPushToken`	`string`	No	—
`mobPushToken`	`string`	No	—
`telegramToken`	`string`	No	—
`messageTag`	`string`	No	—
`activityStatus`	`string`	No	—
`offset`	`string`	No	—
`maxrows`	`number`	No	—

Output: lazy[]

contactMessages

contacts.contactMessages Get an eSputnik contact’s message history Risk: read

await corsair.esputnik.api.contacts.contactMessages({ email: 'ada@example.com', dateFrom: '2026-10-01', dateTo: '2026-11-01', maxrows: 50 });

Input

Name	Type	Required	Description
`dateFrom`	`string`	Yes	—
`dateTo`	`string`	Yes	—
`email`	`string`	No	—
`phone`	`string`	No	—
`contactId`	`number`	No	—
`externalCustomerId`	`string`	No	—
`channelTypes`	`string`	No	—
`offset`	`number`	No	—
`maxrows`	`number`	No	—

Output: lazy[]

contactRecoms

contacts.contactRecoms Get product recommendations for an eSputnik contact Risk: read

await corsair.esputnik.api.contacts.contactRecoms({});

Input

Name	Type	Required	Description
`dataSourceId`	`number`	Yes	—
`contactId`	`number`	No	—
`email`	`string`	No	—
`phone`	`string`	No	—
`externalCustomerId`	`string`	No	—
`webId`	`string`	No	—
`products`	`string`	No	—
`category`	`string`	No	—

Output: lazy[]

contactsBulkUpdate

contacts.contactsBulkUpdate Bulk create or update eSputnik contacts Risk: write

await corsair.esputnik.api.contacts.contactsBulkUpdate({});

Input: object

Input full type

{
}

Output: object

Output full type

{
}

deleteContactByExternalCustomerId

contacts.deleteContactByExternalCustomerId Delete an eSputnik contact by external customer ID Risk: destructive

await corsair.esputnik.api.contacts.deleteContactByExternalCustomerId({});

Input

Name	Type	Required	Description
`externalCustomerId`	`string`	Yes	—
`erase`	`boolean`	No	—

Output: lazy

deleteContactById

contacts.deleteContactById Delete an eSputnik contact by ID Risk: destructive

await corsair.esputnik.api.contacts.deleteContactById({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`erase`	`boolean`	No	—

Output: lazy

deleteFromUnsubscribed

contacts.deleteFromUnsubscribed Remove emails from the eSputnik unsubscribe list Risk: write

await corsair.esputnik.api.contacts.deleteFromUnsubscribed({});

Input

Name	Type	Required	Description
`emails`	`string[]`	Yes	—

Output: lazy

detachContactsFromGroup

contacts.detachContactsFromGroup Remove contacts from an eSputnik static segment Risk: destructive

await corsair.esputnik.api.contacts.detachContactsFromGroup({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`contactIds`	`number[]`	No	—
`externalCustomerIds`	`string[]`	No	—

Output: lazy

fileContactsBulkUpdate

contacts.fileContactsBulkUpdate Import eSputnik contacts from a file link Risk: write

await corsair.esputnik.api.contacts.fileContactsBulkUpdate({});

Input: object

Input full type

{
}

Output: object

Output full type

{
}

getAdditionalFields

contacts.getAdditionalFields List eSputnik contact additional fields Risk: read

await corsair.esputnik.api.contacts.getAdditionalFields({});

Input: empty object Output: object

Output full type

{
}

getContact

contacts.getContact Get an eSputnik contact by ID Risk: read

await corsair.esputnik.api.contacts.getContact({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	No	—

getContactEmails

contacts.getContactEmails Get email addresses for eSputnik contact IDs Risk: read

await corsair.esputnik.api.contacts.getContactEmails({});

Input

Name	Type	Required	Description
`ids`	`string`	Yes	—

Output

Name	Type	Required	Description
`results`	`lazy[]`	Yes	—

getContactIdByToken

contacts.getContactIdByToken Get an eSputnik contact ID by mobile push token Risk: read

await corsair.esputnik.api.contacts.getContactIdByToken({});

Input

Name	Type	Required	Description
`app_uuid`	`string`	Yes	—
`token_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—

getContactSubscriptionCategories

contacts.getContactSubscriptionCategories Get an eSputnik contact’s subscription categories Risk: read

await corsair.esputnik.api.contacts.getContactSubscriptionCategories({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: lazy[]

getGroupContacts

contacts.getGroupContacts Get contacts in an eSputnik segment Risk: read

await corsair.esputnik.api.contacts.getGroupContacts({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`startindex`	`number`	No	—
`maxrows`	`number`	No	—
`orderByTs`	`boolean`	No	—
`asc`	`boolean`	No	—

Output: lazy[]

getImportSessionStatus

contacts.getImportSessionStatus Get eSputnik contact import status Risk: read

await corsair.esputnik.api.contacts.getImportSessionStatus({});

Input

Name	Type	Required	Description
`sessionId`	`string`	Yes	—

Output: object

Output full type

{
}

getSubscriptionCategories

contacts.getSubscriptionCategories List the organisation’s eSputnik subscription categories Risk: read

await corsair.esputnik.api.contacts.getSubscriptionCategories({});

Input: empty object Output: lazy[]

getTokenActivated

contacts.getTokenActivated Get whether an eSputnik mobile push token is active Risk: read

await corsair.esputnik.api.contacts.getTokenActivated({});

Input

Name	Type	Required	Description
`app_uuid`	`string`	Yes	—
`token_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`active`	`boolean`	Yes	—

searchContacts

contacts.searchContacts Search eSputnik contacts (up to 500 per page) Risk: read

await corsair.esputnik.api.contacts.searchContacts({ email: 'ada@example.com', maxrows: 10 });

Input

Name	Type	Required	Description
`startindex`	`number`	No	—
`maxrows`	`number`	No	—
`externalCustomerId`	`string`	No	—
`email`	`string`	No	—
`sms`	`string`	No	—
`firstname`	`string`	No	—
`lastname`	`string`	No	—
`sortBy`	`contactId`	No	—

Output: object[]

Output full type

{
  id?: number
}[]

searchGroups

contacts.searchGroups Search eSputnik segments Risk: read

await corsair.esputnik.api.contacts.searchGroups({});

Input

Name	Type	Required	Description
`startindex`	`number`	No	—
`maxrows`	`number`	No	—
`name`	`string`	No	—

Output: lazy[]

searchWorkflows

contacts.searchWorkflows Search eSputnik workflows Risk: read

await corsair.esputnik.api.contacts.searchWorkflows({});

Input

Name	Type	Required	Description
`startindex`	`number`	No	—
`maxrows`	`number`	No	—
`name`	`string`	No	—

Output: lazy[]

subscribeContact

contacts.subscribeContact Subscribe an eSputnik contact Risk: write

await corsair.esputnik.api.contacts.subscribeContact({});

Input

Name	Type	Required	Description
`contact`	`object`	Yes	—
`groups`	`string[]`	No	—
`subscriptions`	`string[]`	No	—
`formType`	`string`	No	—

contact full type

{
  id?: number,
  firstName?: string,
  lastName?: string,
  channels: {
    type: string,
    value: string,
    device?: {
    },
    webPushSubscription?: {
    }
  }[],
  address?: {
    region?: string,
    town?: string,
    address?: string,
    postcode?: string,
    countryCode?: string | null
  },
  fields?: {
    id: number,
    value: string
  }[],
  addressBookId?: number,
  externalCustomerId?: string,
  languageCode?: string,
  timeZone?: string,
  marketId?: string
}

Output

Name	Type	Required	Description
`id`	`number`	No	—
`emailStatus`	`string`	No	—
`isNew`	`boolean`	No	—

updateContact

contacts.updateContact Update an eSputnik contact by ID Risk: write

await corsair.esputnik.api.contacts.updateContact({});

Input: object

Input full type

{
  id: number
}& {
  id?: number,
  firstName?: string,
  lastName?: string,
  channels: {
    type: string,
    value: string,
    device?: {
    },
    webPushSubscription?: {
    }
  }[],
  address?: {
    region?: string,
    town?: string,
    address?: string,
    postcode?: string,
    countryCode?: string | null
  },
  fields?: {
    id: number,
    value: string
  }[],
  addressBookId?: number,
  externalCustomerId?: string,
  languageCode?: string,
  timeZone?: string,
  marketId?: string
}

Output: lazy

Emails

addEmail

emails.addEmail Create an eSputnik email message Risk: write

await corsair.esputnik.api.emails.addEmail({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`from`	`string`	Yes	—
`subject`	`string`	Yes	—
`htmlText`	`string`	Yes	—
`template`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—

deleteEmail

emails.deleteEmail Delete an eSputnik email message Risk: destructive

await corsair.esputnik.api.emails.deleteEmail({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: lazy

deleteTranslatedEmail

emails.deleteTranslatedEmail Delete a language version of an eSputnik email message Risk: destructive

await corsair.esputnik.api.emails.deleteTranslatedEmail({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`language`	`string`	Yes	—

Output: lazy

getEmail

emails.getEmail Get an eSputnik email message Risk: read

await corsair.esputnik.api.emails.getEmail({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: object

Output full type

{
}

getEmailMessageViewLink

emails.getEmailMessageViewLink Get a link to view an eSputnik email message Risk: read

await corsair.esputnik.api.emails.getEmailMessageViewLink({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: object

Output full type

{
}

searchEmails

emails.searchEmails Search eSputnik email messages by name or tag Risk: read

await corsair.esputnik.api.emails.searchEmails({ search: 'welcome', maxrows: 20 });

Input

Name	Type	Required	Description
`startindex`	`number`	No	—
`maxrows`	`number`	No	—
`search`	`string`	No	—

Output: lazy[]

sendEmail

emails.sendEmail Send an email to eSputnik recipients Risk: write

await corsair.esputnik.api.emails.sendEmail({ from: '"Shop" <news@shop.example.com>', subject: 'Your order', htmlText: '<p>Thanks!</p>', emails: ['ada@example.com'] });

Input: object

Input full type

{
}

Output

Name	Type	Required	Description
`results`	`lazy[]`	Yes	—

updateMessage

emails.updateMessage Update an eSputnik email message Risk: write

await corsair.esputnik.api.emails.updateMessage({});

Input: object

Input full type

{
  id: number
}& {
  name: string,
  from: string,
  subject: string,
  htmlText: string,
  template?: boolean
}

Output: lazy

updateTranslatedMessage

emails.updateTranslatedMessage Add or update a language version of an eSputnik email message Risk: write

await corsair.esputnik.api.emails.updateTranslatedMessage({});

Input: object

Input full type

{
  id: number,
  language: string
}& {
  name: string,
  from: string,
  subject: string,
  htmlText: string,
  template?: boolean
}

Output: lazy

Events

registerEvent

events.registerEvent Send an eSputnik event Risk: write

await corsair.esputnik.api.events.registerEvent({ eventTypeKey: 'cart_abandoned', params: { email: 'ada@example.com', cartUrl: 'https://shop.example.com/cart/42' } });

Input: object

Input full type

{
}

Output: lazy

removeHistoryEvents

events.removeHistoryEvents Delete eSputnik events in a period Risk: destructive

await corsair.esputnik.api.events.removeHistoryEvents({});

Input: object

Input full type

{
}

Output: lazy

sendHistoryEvents

events.sendHistoryEvents Send past eSputnik events Risk: write

await corsair.esputnik.api.events.sendHistoryEvents({});

Input: object

Input full type

{
}

Output: object

Output full type

{
}

Interfaces

getEmailInterfaces

interfaces.getEmailInterfaces List eSputnik email sender addresses Risk: read

await corsair.esputnik.api.interfaces.getEmailInterfaces({});

Input: empty object Output: lazy[]

getSmsInterfaces

interfaces.getSmsInterfaces List eSputnik SMS sender names Risk: read

await corsair.esputnik.api.interfaces.getSmsInterfaces({});

Input: empty object Output: lazy[]

Messages

sendPreparedMessage

messages.sendPreparedMessage Send a prepared eSputnik message to one or more contacts Risk: write

await corsair.esputnik.api.messages.sendPreparedMessage({ id: 4512, recipients: [{ locator: 'ada@example.com', jsonParam: JSON.stringify({ orderId: 42 }) }], email: true });

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`recipients`	`object[]`	Yes	—
`email`	`boolean`	No	—
`fromName`	`string`	No	—

recipients full type

{
  contactId?: number,
  externalCustomerId?: string,
  locator?: string,
  jsonParam?: string,
  externalRequestId?: string,
  languageCode?: string
}[]

Output

Name	Type	Required	Description
`results`	`lazy[]`	Yes	—

updateInteractionStatus

messages.updateInteractionStatus Report a delivery, open or click status for an eSputnik message interaction Risk: write

await corsair.esputnik.api.messages.updateInteractionStatus({});

Input

Name	Type	Required	Description
`interactionId`	`string`	Yes	—
`token`	`string`	No	—
`status`	`DELIVERED \| OPENED \| CLICKED \| UNDELIVERED`	No	—
`time`	`string`	No	—

Output: lazy

Mobile Push

addMobilePushMessage

mobilePush.addMobilePushMessage Create a eSputnik mobile push message Risk: write

await corsair.esputnik.api.mobilePush.addMobilePushMessage({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`title`	`string`	Yes	—
`text`	`string`	Yes	—
`languageCode`	`string`	No	—
`tags`	`string[]`	No	—
`link`	`string`	No	—
`imageSource`	`string`	No	—
`customData`	`string`	No	—
`ttlSec`	`number`	No	—
`soundEnabled`	`boolean`	No	—
`badgeCount`	`number`	No	—
`images`	`string[]`	No	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—

deleteMobilePushMessage

mobilePush.deleteMobilePushMessage Delete a eSputnik mobile push message Risk: destructive

await corsair.esputnik.api.mobilePush.deleteMobilePushMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: lazy

deleteTranslatedMobilePushMessage

mobilePush.deleteTranslatedMobilePushMessage Delete a language version of a eSputnik mobile push message Risk: destructive

await corsair.esputnik.api.mobilePush.deleteTranslatedMobilePushMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`language`	`string`	Yes	—

Output: lazy

getMobilePushMessage

mobilePush.getMobilePushMessage Get a eSputnik mobile push message with its language versions Risk: read

await corsair.esputnik.api.mobilePush.getMobilePushMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: object

Output full type

{
}

searchMobilePushMessages

mobilePush.searchMobilePushMessages Search eSputnik mobile push messages by name Risk: read

await corsair.esputnik.api.mobilePush.searchMobilePushMessages({});

Input

Name	Type	Required	Description
`startindex`	`number`	No	—
`maxrows`	`number`	No	—
`search`	`string`	No	—

Output: lazy[]

updateBaseMobilePushMessage

mobilePush.updateBaseMobilePushMessage Update a eSputnik mobile push message Risk: write

await corsair.esputnik.api.mobilePush.updateBaseMobilePushMessage({});

Input: object

Input full type

{
  id: number
}& {
  name: string,
  title: string,
  text: string,
  languageCode?: string,
  tags?: string[],
  link?: string,
  imageSource?: string,
  customData?: string,
  ttlSec?: number,
  soundEnabled?: boolean,
  badgeCount?: number,
  images?: string[]
}

Output: lazy

updateTranslatedMobilePushMessage

mobilePush.updateTranslatedMobilePushMessage Add or update a language version of a eSputnik mobile push message Risk: write

await corsair.esputnik.api.mobilePush.updateTranslatedMobilePushMessage({});

Input: object

Input full type

{
  id: number,
  language: string
}& {
  name: string,
  title: string,
  text: string,
  languageCode?: string,
  tags?: string[],
  link?: string,
  imageSource?: string,
  customData?: string,
  ttlSec?: number,
  soundEnabled?: boolean,
  badgeCount?: number,
  images?: string[]
}

Output: lazy

Orders

ordersBulkInsert

orders.ordersBulkInsert Add or update eSputnik orders Risk: write

await corsair.esputnik.api.orders.ordersBulkInsert({});

Input: object

Input full type

{
}

Output: object

Output full type

{
}

Preprocessor

getPreprocessorFileStatus

preprocessor.getPreprocessorFileStatus Get the status of an eSputnik preprocessor file upload Risk: read

await corsair.esputnik.api.preprocessor.getPreprocessorFileStatus({});

Input

Name	Type	Required	Description
`sessionId`	`string`	Yes	—

Output: lazy

updatePreprocessorFile

preprocessor.updatePreprocessorFile Replace the data of an eSputnik preprocessor file Risk: write

await corsair.esputnik.api.preprocessor.updatePreprocessorFile({});

Input

Name	Type	Required	Description
`fileId`	`string`	Yes	—
`link`	`string`	Yes	—
`ttlHours`	`number`	No	—

Output: object

Output full type

{
}

uploadPreprocessorFile

preprocessor.uploadPreprocessorFile Upload an eSputnik preprocessor file from a link Risk: write

await corsair.esputnik.api.preprocessor.uploadPreprocessorFile({});

Input

Name	Type	Required	Description
`link`	`string`	Yes	—
`preprocessorType`	`string`	Yes	—
`ttlHours`	`number`	No	—

Output: object

Output full type

{
}

Product Feeds

configureProductFeeds

productFeeds.configureProductFeeds Configure eSputnik product feeds Risk: write

await corsair.esputnik.api.productFeeds.configureProductFeeds({});

Input

Name	Type	Required	Description
`feeds`	`object[]`	Yes	—

feeds full type

{
  url: string,
  language?: string,
  default?: boolean
}[]

Output: lazy

getProductFeedsConfiguration

productFeeds.getProductFeedsConfiguration Get eSputnik product feed configuration Risk: read

await corsair.esputnik.api.productFeeds.getProductFeedsConfiguration({});

Input: empty object Output: object

Output full type

{
}

Promocodes

getPromocodes

promocodes.getPromocodes Get available eSputnik promotional codes Risk: read

await corsair.esputnik.api.promocodes.getPromocodes({});

Input

Name	Type	Required	Description
`type`	`string`	No	—
`inUse`	`boolean`	No	—
`activeDueDays`	`number`	No	—
`discount`	`number`	No	—

Output: lazy

getPromocodesCount

promocodes.getPromocodesCount Count available eSputnik promotional codes Risk: read

await corsair.esputnik.api.promocodes.getPromocodesCount({});

Input

Name	Type	Required	Description
`type`	`string`	No	—
`activeDueDays`	`number`	No	—
`discount`	`number`	No	—

Output: lazy

insertPromocodes

promocodes.insertPromocodes Upload eSputnik promotional codes Risk: write

await corsair.esputnik.api.promocodes.insertPromocodes({});

Input

Name	Type	Required	Description
`promocodes`	`string[]`	Yes	—
`expirationDate`	`string`	Yes	—
`discount`	`number`	Yes	—
`type`	`string`	No	—
`inUse`	`boolean`	No	—

Output: lazy

Site

addWebPushDomain

site.addWebPushDomain Register an eSputnik web push domain Risk: write

await corsair.esputnik.api.site.addWebPushDomain({});

Input

Name	Type	Required	Description
`domain`	`string`	Yes	—
`serviceWorkerName`	`string`	Yes	—
`serviceWorkerPath`	`string`	Yes	—
`serviceWorkerScope`	`string`	Yes	—

Output: object

Output full type

{
}

createDomain

site.createDomain Register a domain for eSputnik web tracking Risk: write

await corsair.esputnik.api.site.createDomain({});

Input

Name	Type	Required	Description
`domain`	`string`	Yes	—

Output: object

Output full type

{
}

deleteWebPushDomain

site.deleteWebPushDomain Delete an eSputnik web push domain Risk: destructive

await corsair.esputnik.api.site.deleteWebPushDomain({});

Input

Name	Type	Required	Description
`domain`	`string`	Yes	—

Output: lazy

getDomains

site.getDomains Get the organisation’s eSputnik web tracking domain Risk: read

await corsair.esputnik.api.site.getDomains({});

Input: empty object Output: lazy[]

getScript

site.getScript Get the eSputnik web tracking script Risk: read

await corsair.esputnik.api.site.getScript({});

Input: empty object Output: string

getWebPushDomains

site.getWebPushDomains List eSputnik web push domains Risk: read

await corsair.esputnik.api.site.getWebPushDomains({});

Input: empty object Output: object

Output full type

{
}

getWebPushScript

site.getWebPushScript Get the eSputnik web push script for a domain Risk: read

await corsair.esputnik.api.site.getWebPushScript({});

Input

Name	Type	Required	Description
`domain`	`string`	No	—

Output: object

Output full type

{
}

Sms

addSmsMessage

sms.addSmsMessage Create a eSputnik SMS message Risk: write

await corsair.esputnik.api.sms.addSmsMessage({});

Input: object

Input full type

{
}

Output

Name	Type	Required	Description
`id`	`number`	Yes	—

deleteSmsMessage

sms.deleteSmsMessage Delete a eSputnik SMS message Risk: destructive

await corsair.esputnik.api.sms.deleteSmsMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: lazy

deleteTranslatedSmsMessage

sms.deleteTranslatedSmsMessage Delete a language version of a eSputnik SMS message Risk: destructive

await corsair.esputnik.api.sms.deleteTranslatedSmsMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`language`	`string`	Yes	—

Output: lazy

getSms

sms.getSms Get a eSputnik SMS message with its language versions Risk: read

await corsair.esputnik.api.sms.getSms({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: object

Output full type

{
}

searchSmsMessages

sms.searchSmsMessages Search eSputnik SMS messages by name Risk: read

await corsair.esputnik.api.sms.searchSmsMessages({});

Input

Name	Type	Required	Description
`startindex`	`number`	No	—
`maxrows`	`number`	No	—
`search`	`string`	No	—

Output: lazy[]

sendSms

sms.sendSms Send an SMS to eSputnik recipients Risk: write

await corsair.esputnik.api.sms.sendSms({ from: 'Shop', text: 'Your code is 4821', phoneNumbers: ['380501234567'] });

Input: object

Input full type

{
}

Output

Name	Type	Required	Description
`results`	`lazy[]`	Yes	—

updateBaseSmsMessage

sms.updateBaseSmsMessage Update a eSputnik SMS message Risk: write

await corsair.esputnik.api.sms.updateBaseSmsMessage({});

Input: object

Input full type

{
  id: number
}& {
}

Output: lazy

updateTranslatedSmsMessage

sms.updateTranslatedSmsMessage Add or update a language version of a eSputnik SMS message Risk: write

await corsair.esputnik.api.sms.updateTranslatedSmsMessage({});

Input: object

Input full type

{
  id: number,
  language: string
}& {
}

Output: lazy

Telegram Bot

addTelegramBotMessage

telegramBot.addTelegramBotMessage Create a eSputnik Telegram bot message Risk: write

await corsair.esputnik.api.telegramBot.addTelegramBotMessage({});

Input: object

Input full type

{
}

Output

Name	Type	Required	Description
`id`	`number`	Yes	—

deleteTelegramBotMessage

telegramBot.deleteTelegramBotMessage Delete a eSputnik Telegram bot message Risk: destructive

await corsair.esputnik.api.telegramBot.deleteTelegramBotMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: lazy

deleteTranslatedTelegramMessage

telegramBot.deleteTranslatedTelegramMessage Delete a language version of a eSputnik Telegram bot message Risk: destructive

await corsair.esputnik.api.telegramBot.deleteTranslatedTelegramMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`language`	`string`	Yes	—

Output: lazy

getTelegramBotMessage

telegramBot.getTelegramBotMessage Get a eSputnik Telegram bot message with its language versions Risk: read

await corsair.esputnik.api.telegramBot.getTelegramBotMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: object

Output full type

{
}

searchTelegramBotMessages

telegramBot.searchTelegramBotMessages Search eSputnik Telegram bot messages by name Risk: read

await corsair.esputnik.api.telegramBot.searchTelegramBotMessages({});

Input

Name	Type	Required	Description
`startindex`	`number`	No	—
`maxrows`	`number`	No	—
`search`	`string`	No	—

Output: lazy[]

updateBaseTelegramBotMessage

telegramBot.updateBaseTelegramBotMessage Update a eSputnik Telegram bot message Risk: write

await corsair.esputnik.api.telegramBot.updateBaseTelegramBotMessage({});

Input: object

Input full type

{
  id: number
}& {
}

Output: lazy

updateTranslatedTelegramMessage

telegramBot.updateTranslatedTelegramMessage Add or update a language version of a eSputnik Telegram bot message Risk: write

await corsair.esputnik.api.telegramBot.updateTranslatedTelegramMessage({});

Input: object

Input full type

{
  id: number,
  language: string
}& {
}

Output: lazy

Viber

addViberMessage

viber.addViberMessage Create a eSputnik Viber message Risk: write

await corsair.esputnik.api.viber.addViberMessage({});

Input: object

Input full type

{
}

Output

Name	Type	Required	Description
`id`	`number`	Yes	—

deleteTranslatedViberMessage

viber.deleteTranslatedViberMessage Delete a language version of a eSputnik Viber message Risk: destructive

await corsair.esputnik.api.viber.deleteTranslatedViberMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`language`	`string`	Yes	—

Output: lazy

deleteViberMessage

viber.deleteViberMessage Delete a eSputnik Viber message Risk: destructive

await corsair.esputnik.api.viber.deleteViberMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: lazy

getViberMessage

viber.getViberMessage Get a eSputnik Viber message with its language versions Risk: read

await corsair.esputnik.api.viber.getViberMessage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output: object

Output full type

{
}

searchViberMessages

viber.searchViberMessages Search eSputnik Viber messages by name Risk: read

await corsair.esputnik.api.viber.searchViberMessages({});

Input

Name	Type	Required	Description
`startindex`	`number`	No	—
`maxrows`	`number`	No	—
`search`	`string`	No	—

Output: lazy[]

sendViber

viber.sendViber Send a Viber message to eSputnik recipients Risk: write

await corsair.esputnik.api.viber.sendViber({});

Input: object

Input full type

{
}

Output

Name	Type	Required	Description
`results`	`lazy[]`	Yes	—

updateBaseViberMessage

viber.updateBaseViberMessage Update a eSputnik Viber message Risk: write

await corsair.esputnik.api.viber.updateBaseViberMessage({});

Input: object

Input full type

{
  id: number
}& {
}

Output: lazy

updateTranslatedViberMessage

viber.updateTranslatedViberMessage Add or update a language version of a eSputnik Viber message Risk: write

await corsair.esputnik.api.viber.updateTranslatedViberMessage({});

Input: object

Input full type

{
  id: number,
  language: string
}& {
}

Output: lazy

​Account

​generateApiToken

​getAccountInfo

​getBalance

​getOrganisationBalanceHistory

​App Inbox

​addAppInboxMessage

​deleteAppInboxMessage

​deleteTranslatedAppInboxMessage

​getAppInboxMessage

​searchAppInboxMessages

​updateBaseAppInboxMessage

​updateTranslatedAppInboxMessage

​Apps

​addAppTokens

​muteAppToken

​unmuteAppToken

​Broadcasts

​cancelBroadcast

​createBroadcast

​getBroadcast

​getBroadcasts

​Contacts

​addContact

​addToUnsubscribed

​attachContactsToGroup

​changeContactSubscriptionCategories

​changeTokenActivated

​contactActivity

​contactMessages

​contactRecoms

​contactsBulkUpdate

​deleteContactByExternalCustomerId

​deleteContactById

​deleteFromUnsubscribed

​detachContactsFromGroup

​fileContactsBulkUpdate

​getAdditionalFields

​getContact

​getContactEmails

​getContactIdByToken

​getContactSubscriptionCategories

​getGroupContacts

​getImportSessionStatus

​getSubscriptionCategories

​getTokenActivated

​searchContacts

​searchGroups

​searchWorkflows

​subscribeContact

​updateContact

​Emails

​addEmail

​deleteEmail

​deleteTranslatedEmail

​getEmail

​getEmailMessageViewLink

​searchEmails

​sendEmail

​updateMessage

​updateTranslatedMessage

​Events

​registerEvent

​removeHistoryEvents

​sendHistoryEvents

​Interfaces

​getEmailInterfaces

​getSmsInterfaces

​Messages

​sendPreparedMessage

​updateInteractionStatus

​Mobile Push

​addMobilePushMessage

​deleteMobilePushMessage

​deleteTranslatedMobilePushMessage

​getMobilePushMessage

​searchMobilePushMessages

​updateBaseMobilePushMessage

​updateTranslatedMobilePushMessage

​Orders

Account

generateApiToken

getAccountInfo

getBalance

getOrganisationBalanceHistory

App Inbox

addAppInboxMessage

deleteAppInboxMessage

deleteTranslatedAppInboxMessage

getAppInboxMessage

searchAppInboxMessages

updateBaseAppInboxMessage

updateTranslatedAppInboxMessage

Apps

addAppTokens

muteAppToken

unmuteAppToken

Broadcasts

cancelBroadcast

createBroadcast

getBroadcast

getBroadcasts

Contacts

addContact

addToUnsubscribed

attachContactsToGroup

changeContactSubscriptionCategories

changeTokenActivated

contactActivity

contactMessages

contactRecoms

contactsBulkUpdate

deleteContactByExternalCustomerId

deleteContactById

deleteFromUnsubscribed

detachContactsFromGroup

fileContactsBulkUpdate

getAdditionalFields

getContact

getContactEmails

getContactIdByToken

getContactSubscriptionCategories

getGroupContacts

getImportSessionStatus

getSubscriptionCategories

getTokenActivated

searchContacts

searchGroups

searchWorkflows

subscribeContact

updateContact

Emails

addEmail

deleteEmail

deleteTranslatedEmail

getEmail

getEmailMessageViewLink

searchEmails

sendEmail

updateMessage

updateTranslatedMessage

Events

registerEvent

removeHistoryEvents

sendHistoryEvents

Interfaces

getEmailInterfaces

getSmsInterfaces

Messages

sendPreparedMessage

updateInteractionStatus

Mobile Push

addMobilePushMessage

deleteMobilePushMessage

deleteTranslatedMobilePushMessage

getMobilePushMessage

searchMobilePushMessages

updateBaseMobilePushMessage

updateTranslatedMobilePushMessage

Orders