# eSputnik Documentation
## Guides
- [Home Page Performance Dashboard](https://docs.esputnik.com/docs/home-page-performance-dashboard.md)
- [In-App Report](https://docs.esputnik.com/docs/in-app-report.md)
- [Message Analytics](https://docs.esputnik.com/docs/message-analytics.md)
- [Setting Up UTM Tags](https://docs.esputnik.com/docs/setting-up-utm-tags.md)
- [Telegram Campaign Report](https://docs.esputnik.com/docs/telegram-campaign-report.md)
- [Viber Campaign Report](https://docs.esputnik.com/docs/viber-campaign-report.md)
- [Contact Reports](https://docs.esputnik.com/docs/contact-reports.md)
- [Unsubscribe Page/Unsubscribe Reasons Analysis](https://docs.esputnik.com/docs/unsubscribe-pageunsubscribe-reason-analysis.md)
- [API Methods for Adding Contacts](https://docs.esputnik.com/docs/api-methods-for-add-contacts.md)
- [FAQ: Integrating with API](https://docs.esputnik.com/docs/faq-integrating-with-api.md)
- [API Methods](https://docs.esputnik.com/docs/api-1.md)
- [Sending Orders via the API Resource Generate event](https://docs.esputnik.com/docs/sending-orders-via-the-api-resource-generate-event.md)
- [Sending Product Recommendations via API](https://docs.esputnik.com/docs/sending-product-recommendations-via-api.md)
- [Using the Generate Event API Resource](https://docs.esputnik.com/docs/using-the-generate-event-api-resource.md)
- [Using the Send Prepared Message API Method](https://docs.esputnik.com/docs/using-the-send-prepared-message-api-method.md)
- [Birthday Campaign](https://docs.esputnik.com/docs/birthday-campaign.md)
- [Sending Reminders at the Time Specified by the User](https://docs.esputnik.com/docs/sending-reminders-time-specified.md)
- [Using A/B Tests In Workflows](https://docs.esputnik.com/docs/using-ab-tests-in-workflows.md)
- [Advanced Workflow Block Parameters](https://docs.esputnik.com/docs/advanced-workflow-block-parameters.md)
- [Using One from Many Message Block](https://docs.esputnik.com/docs/optimizing-campaigns-using-one-from-many-message-block.md)
- [Using Branch Block](https://docs.esputnik.com/docs/using-branch-block.md)
- [Setting Up an Abandoned Cart Workflow](https://docs.esputnik.com/docs/abandoned-carts.md)
- [Setting Up an Abandoned Browse Workflow](https://docs.esputnik.com/docs/abandoned-views.md)
- [Reminder about Promo Code from Gamified Request Form](https://docs.esputnik.com/docs/reminder-about-promo-code-from-gamified-request-form.md)
- [Reminder about Promo Code from Gamified Subscription Form](https://docs.esputnik.com/docs/reminder-about-promo-code-from-subscription-form.md)
- [Setting Broadcast Frequency Strategy](https://docs.esputnik.com/docs/how-to-make-a-campaign-using-optimal-messaging-frequency-strategy.md)
- [Building a Customer Loyalty Survey](https://docs.esputnik.com/docs/how-create-survey.md)
- [Exporting Data to the BigQuery Tables](https://docs.esputnik.com/docs/exporting-data-to-the-bigquery-tables.md)
- [Importing Data from the BigQuery Tables](https://docs.esputnik.com/docs/importing-data-from-the-bigquery-tables.md)
- [Exchanging Data With Google BigQuery](https://docs.esputnik.com/docs/exchanging-data-with-google-bigquery.md)
- [Testing & Troubleshooting Velocity](https://docs.esputnik.com/docs/testing-troubleshooting-velocity.md)
- [Velocity in Workflows](https://docs.esputnik.com/docs/velocity-in-workflows.md)
- [Data Transfer & Personalization: Overview](https://docs.esputnik.com/docs/overview.md)
- [Creating an AMP Form](https://docs.esputnik.com/docs/how-create-amp-form.md)
- [Creating an AMP Accordion](https://docs.esputnik.com/docs/how-create-amp-powered-accordion.md)
- [Creating an AMP Carousel](https://docs.esputnik.com/docs/how-create-amp-powered-carousel.md)
- [Managing Data Collected via AMP Forms](https://docs.esputnik.com/docs/how-manage-data-collected-amp-forms.md)
- [AMP](https://docs.esputnik.com/docs/amp.md)
- [Responsive Email Editor Overview](https://docs.esputnik.com/docs/adaptive-email-builder-review.md)
- [Setting Up Responsive Email Design](https://docs.esputnik.com/docs/all-adaptivity-email-builder.md)
- [Collaborative Email Creation: Co-editing and Comments](https://docs.esputnik.com/docs/collaborative-email-creation-co-editing-and-comments.md)
- [Creating Timer](https://docs.esputnik.com/docs/creating-timer.md)
- [Designing Your Email](https://docs.esputnik.com/docs/designing-your-email.md)
- [Display Conditions for Email Template Elements](https://docs.esputnik.com/docs/display-conditions-for-email-template-elements.md)
- [Email Structure](https://docs.esputnik.com/docs/email-structure.md)
- [Adding Anchor Links](https://docs.esputnik.com/docs/how-add-anchor-links-email.md)
- [Adding The Rollover Effect](https://docs.esputnik.com/docs/how-add-rollover-effect-email.md)
- [Adding a Table to an Email](https://docs.esputnik.com/docs/how-add-table-emails.md)
- [Creating a Gmail Promotions Annotation](https://docs.esputnik.com/docs/how-create-gmail-promotions-annotations-emails.md)
- [Email Editor](https://docs.esputnik.com/docs/email-editor.md)
- [Messenger Protocol Support in Email Clients and Platforms](https://docs.esputnik.com/docs/messenger-protocol-support-in-email-clients-and-platforms.md)
- [Module Library](https://docs.esputnik.com/docs/module-library.md)
- [Working with Images](https://docs.esputnik.com/docs/working-with-images.md)
- [Adding BIMI Logo](https://docs.esputnik.com/docs/adding-bimi-logo.md)
- [Checking Domain Settings and Reputation with Google Postmaster Tools](https://docs.esputnik.com/docs/checking-domain-settings-and-reputation-google-postmaster-tools.md)
- [Deliverability Control Process](https://docs.esputnik.com/docs/deliverability-control-process.md): Monitoring and rules to follow when sending emails (and what happens if you don’t)
- [Email Deliverability: Getting Started](https://docs.esputnik.com/docs/email-deliverability-getting-started.md)
- [FAQ: Setting Up Digital Signatures and Domain Reputation](https://docs.esputnik.com/docs/faq-setting-digital-signatures.md)
- [Guide on Delivering Email to Apple User Relay Address](https://docs.esputnik.com/docs/guide-on-delivering-email-to-apple-user-relay-address.md)
- [Unsubscribe Forms](https://docs.esputnik.com/docs/unsubscribe-forms.md)
- [Preparation for Campaign Launch](https://docs.esputnik.com/docs/compose-email.md)
- [FAQ: Launching First Campaign](https://docs.esputnik.com/docs/faq-launching-first-campaign.md)
- [Adding a Hidden Preheader](https://docs.esputnik.com/docs/how-add-hidden-preheader-email.md)
- [Testing Email Subject Lines](https://docs.esputnik.com/docs/how-test-email-subject-lines.md)
- [Editing Cards in the Products Block](https://docs.esputnik.com/docs/editing-cards-in-the-products-block.md)
- [Product Blocks](https://docs.esputnik.com/docs/product-blocks.md)
- [Testing the Products Block](https://docs.esputnik.com/docs/testing-the-products-block.md)
- [Price and Discount Blocks](https://docs.esputnik.com/docs/using-the-price-block.md)
- [Products Block](https://docs.esputnik.com/docs/using-the-products-block.md)
- [Naming Custom Events](https://docs.esputnik.com/docs/custom-event-naming-conventions.md)
- [Event Analytics](https://docs.esputnik.com/docs/event-analytics.md)
- [Splitting the Workflow Depending on the Event Parameters](https://docs.esputnik.com/docs/splitting-the-workflow-depending-on-the-event-parameters.md)
- [Setting Up Web Tracking to Personalize Content on the Site and in Campaigns](https://docs.esputnik.com/docs/setting-web-tracking-personalize-content-site-and-campaigns.md)
- [Short Links Settings](https://docs.esputnik.com/docs/creating-a-custom-domain-for-url-shortening.md)
- [Account Management](https://docs.esputnik.com/docs/account-management.md): Create and manage your eSputnik account
- [User/Account Time Zone Settings](https://docs.esputnik.com/docs/user-and-account-time-zone-settings.md)
- [eSputnik Main Sections Overview](https://docs.esputnik.com/docs/esputnik-main-sections-overview.md)
- [FAQ: Billing](https://docs.esputnik.com/docs/faq-billing.md)
- [FAQ: Quick Start](https://docs.esputnik.com/docs/faq-quick-start.md)
- [Getting Started with eSputnik AI: Launch Smarter, Faster Campaigns](https://docs.esputnik.com/docs/getting-started-with-esputnik-ai.md)
- [What Is eSputnik?](https://docs.esputnik.com/docs/what-is-esputnik.md)
- [Integrating eSputnik with Claude Cowork](https://docs.esputnik.com/docs/integrating-esputnik-with-claude-cowork.md)
- [Naming and Tagging Conventions](https://docs.esputnik.com/docs/naming-and-tagging-conventions.md)
- [Integration with CMS](https://docs.esputnik.com/docs/cms-integration-guide.md)
- [Website Integration](https://docs.esputnik.com/docs/website-integration.md)
- [Integration with WooCommerce](https://docs.esputnik.com/docs/installing-plugin-for-woocommerce-sites.md)
- [Integration with Horoshop](https://docs.esputnik.com/docs/integrating-with-horoshop.md)
- [Integration with Shopify](https://docs.esputnik.com/docs/integrating-with-shopify.md)
- [Integration with OpenCart](https://docs.esputnik.com/docs/integration-with-opencart.md)
- [How to Migrate to Our Platform from Other Services](https://docs.esputnik.com/docs/how-migrate-to-our-platform.md)
- [Manage Translations](https://docs.esputnik.com/docs/manage-translations.md)
- [7 In-App Campaign Best Practices](https://docs.esputnik.com/docs/7-app-campaign-best-practices.md)
- [Ideas & Designs for In-App Messaging](https://docs.esputnik.com/docs/ideas-designs-app-messaging.md)
- [In-App Publishing and Triggering Rules](https://docs.esputnik.com/docs/in-app-publishing-and-triggering-rules.md)
- [In-App](https://docs.esputnik.com/docs/in-app.md)
- [Linking In-App with Mobile Push](https://docs.esputnik.com/docs/linking-in-app-with-mobile-push.md)
- [Managing In-App Campaigns](https://docs.esputnik.com/docs/managing-app-campaigns.md)
- [Running A/B Tests for In-App Messages](https://docs.esputnik.com/docs/running-ab-tests-for-in-app-messages.md)
- [Connecting Mobile App](https://docs.esputnik.com/docs/connect-your-mobile-app.md)
- [Creating Mobile Push Message](https://docs.esputnik.com/docs/creating-mobile-push-message.md)
- [Error Codes for Mob Push Notifications](https://docs.esputnik.com/docs/error-codes-mob-push.md)
- [Deep Link Types](https://docs.esputnik.com/docs/how-create-deep-links-and-universal-links.md)
- [Creating and Uploading a Firebase Key](https://docs.esputnik.com/docs/how-to-create-a-google-project-for-mobile-push-notifications.md)
- [Mobile Push](https://docs.esputnik.com/docs/mobile-push.md)
- [Mobile Push Generation Using Built-in AI in the One from Many Block](https://docs.esputnik.com/docs/mobile-push-generation.md)
- [Scheduled Mobile Push Message](https://docs.esputnik.com/docs/scheduled-mobile-push-message.md)
- [SDK for Mobile Apps](https://docs.esputnik.com/docs/sdk-mobile-apps.md)
- [Sending Test Messages from the Event Debug View](https://docs.esputnik.com/docs/sending-test-messages-from-the-event-debug-view.md)
- [Setting Up Delivery and Clicks Analytics](https://docs.esputnik.com/docs/setting-delivery-and-clicks-analytics.md)
- [Creating Telegram Message](https://docs.esputnik.com/docs/creating-telegram-message.md)
- [Telegram](https://docs.esputnik.com/docs/telegram.md)
- [Integrating with Telegram Bot](https://docs.esputnik.com/docs/integrating-with-telegram-bot.md)
- [Muting or Unmuting Telegram Notifications for Users](https://docs.esputnik.com/docs/muting-or-unmuting-telegram-notifications-for-users.md)
- [Adding a Sender Name](https://docs.esputnik.com/docs/how-add-sender-name-viber.md)
- [Viber](https://docs.esputnik.com/docs/viber.md)
- [Automatically Sending SMS to Contacts without Viber](https://docs.esputnik.com/docs/send-sms-those-who-do-not-have-viber.md)
- [Creating a Viber Campaign](https://docs.esputnik.com/docs/viber-messages-creation.md)
- [Creating a Welcome Series for Web Push](https://docs.esputnik.com/docs/creating-welcome-series-web-push.md)
- [Adding Data on User’s Web Activity to Push](https://docs.esputnik.com/docs/sending-user-personalized-push-notification.md)
- [Actions After Subsciption](https://docs.esputnik.com/docs/actions-after-form-submission.md)
- [Collecting Contact Information Using Request Forms](https://docs.esputnik.com/docs/collecting-contact-information-using-request-forms.md)
- [Widgets](https://docs.esputnik.com/docs/widgets.md)
- [NPS/Rating Widget Components](https://docs.esputnik.com/docs/npsrating-widget-components.md)
- [Setting Up Locations for the Widget Calling Rules](https://docs.esputnik.com/docs/setting-up-locations-for-the-widget-calling-rules.md)
- [Substituting Data through Merge Tags](https://docs.esputnik.com/docs/substituting-data-from-the-data-layer-through-merge-tags.md)
- [Widget Calling Using JavaScript Variables](https://docs.esputnik.com/docs/widget-calling-using-javascript-variables.md)
- [Widget Calling](https://docs.esputnik.com/docs/widget-calling.md)
- [Widgets Gamification](https://docs.esputnik.com/docs/widgets-gamification.md)
- [Activation of Behavioral Triggers](https://docs.esputnik.com/docs/activation-of-behavioral-triggers.md)
- [Creating a Viber Message with Recommendations](https://docs.esputnik.com/docs/creating-a-message-with-recommendations.md)
- [Recommendations in Viber Messages](https://docs.esputnik.com/docs/recommendations-in-viber-messages.md)
- [Minimizing CLS to Speed Up Page Loads](https://docs.esputnik.com/docs/minimizing-cls-to-speed-up-page-loads.md)
- [JS API Requests for Different Site Page Types](https://docs.esputnik.com/docs/passing-recommendations-using-the-javascript-api.md)
- [GDPR Compliance](https://docs.esputnik.com/docs/gdpr-compliance.md)
- [Collecting Contact Data from Campaigns](https://docs.esputnik.com/docs/collecting-contact-data-from-campaigns.md)
- [Subscriber Data Collection](https://docs.esputnik.com/docs/subscriber-data-collection.md)
- [Bulk Contact Uploading](https://docs.esputnik.com/docs/bulk-contact-uploading.md)
- [Contact Updating via SDK](https://docs.esputnik.com/docs/contact-updating-via-sdk.md)
- [Uploading and Updating Contacts](https://docs.esputnik.com/docs/uploading-and-updating-contacts.md)
- [Real-Time Contact Updating](https://docs.esputnik.com/docs/real-time-contact-updating.md)
- [Bulk Contact Import via Get Started Section](https://docs.esputnik.com/docs/bulk-contact-import-via-get-started-section.md)
- [Contact Blacklist](https://docs.esputnik.com/docs/contact-blacklist.md)
- [FAQ: Working with Contacts](https://docs.esputnik.com/docs/faq-working-contacts.md)
- [Opening a CSV File After Export](https://docs.esputnik.com/docs/opening-a-csv-file-after-export.md)
- [Using the All Contacts Tab](https://docs.esputnik.com/docs/using-the-all-contacts-tab.md): This article can help you to understand how to manage your contact base.
## API Reference
- [API Keys](https://docs.esputnik.com/reference/api-keys.md)
- [Getting Started With API](https://docs.esputnik.com/reference/getting-started-with-your-api.md): Overview of API functionality
- [OAuth 2.0 Authentication for eSputnik API](https://docs.esputnik.com/reference/oauth-20-authentication-for-esputnik-api.md)
- [Rate Limits](https://docs.esputnik.com/reference/rate-limits.md): The number of requests the API consumer can make in a second
- [Get account info](https://docs.esputnik.com/reference/getaccountinfo-1.md): The method returns the account name.
- [Get organization billing history](https://docs.esputnik.com/reference/getorganisationbalancehistory.md): The method returns the billing history of the account.
- [Get organization balance](https://docs.esputnik.com/reference/getuserorganisationbalance-1.md): The method returns the balance for the account.
- [Add application tokens](https://docs.esputnik.com/reference/addapptokens.md): The method is used for adding Telegram application tokens.
- [Mute application tokens](https://docs.esputnik.com/reference/muteapptoken.md): The method mutes notifications to Telegram users having tokens. Read more.
- [Unmute application tokens](https://docs.esputnik.com/reference/unmuteapptoken.md): The method unmutes notifications to Telegram users having tokens. Read more.
- [Change token activity](https://docs.esputnik.com/reference/changetokenactivated-1.md): The method is used for changing activity status of the mobile token.
- [Get contacts activity](https://docs.esputnik.com/reference/contactactivity-1.md): The method returns the contact activity on subscriptions.
- [Get contact's message history](https://docs.esputnik.com/reference/contactmessages-1.md): The method returns the contact's message history.
Supported media types: Email, SMS, Viber, Mobile Push, Web Push, App Inbox, Telegram.
- [Get token activity](https://docs.esputnik.com/reference/gettokenactivated-1.md): The method returns activity status of the mobile token: {"active":true} or {"active":false}.
- [Add/update a contact](https://docs.esputnik.com/reference/addcontact-1.md): Creates or updates contacts in real-time. Details >.
The guide on bulk contact uploading and updating is available at the link.
Request example.
- [Add emails to unsubscribed list](https://docs.esputnik.com/reference/addtounsubscribed-1.md): The method is used for adding email addresses to the list of unsubscribed contacts.
- [Attach contact to static segment](https://docs.esputnik.com/reference/attachcontactstogroup-1.md): Attach contact to static segment by contact ids or external customer ids
- [Update contact subscriptions](https://docs.esputnik.com/reference/changecontactsubscriptioncategories-1.md): The method is used for updating the categories that a contact subscribed for.
- [Contact recommendations based on web tracking](https://docs.esputnik.com/reference/contactrecoms-1.md): The method returns recommendations for a contact based on the web tracking.
NOTE: Version 2 API methods do not require escaping in nested JSON.
- [Add/update contacts](https://docs.esputnik.com/reference/contactsbulkupdate-1.md): The method adds new contacts and updates existing contacts. Asynchronous processing is used; requests may be handled in a different order or concurrently.
- [Delete contact](https://docs.esputnik.com/reference/deletecontact_1.md): The method is used for deleting a contact identified by contactID.
- [Delete contact by externalCustomerId](https://docs.esputnik.com/reference/deletecontact-1.md): The method is used for deleting a contact identified by externalCustomerId.
- [Remove emails from unsubscribed list](https://docs.esputnik.com/reference/deletefromunsubscribed-1.md): The method is used for removing email addresses from the list of unsubscribed contacts.
- [Delete from static segment](https://docs.esputnik.com/reference/detachcontactsfromgroup-1.md): The method deletes contacts from a static segment by contact ids or external customer ids. If don't specify any ids, all contacts will be deleted from the segment.
- [Add/update contacts from external file](https://docs.esputnik.com/reference/filecontactsbulkupdate-1.md): The method is used to import or update the contacts from an external file. The method creates new contacts and updates existing ones.
- [Get the list of catalogs](https://docs.esputnik.com/reference/getaddressbooks-1.md): The method returns a list of catalogs. A catalog contains the list of additional fields available for contacts in your organisation.
- [Get contact](https://docs.esputnik.com/reference/getcontact-1.md): The method returns the available information about the contact identified by the contact ID.
- [Get email by contactID](https://docs.esputnik.com/reference/getcontactemails-1.md): The method is used for getting the email addresses of contacts by their contactID.
- [Get contact ID by Mobile Push token](https://docs.esputnik.com/reference/getcontactidbytoken-1.md): The method is used for getting the ID of a contact using the Mobile Push token ID.
- [Get contact subscriptions](https://docs.esputnik.com/reference/getcontactsubscriptioncategories-1.md): The method is used for getting the names of categories a contact subscribed for.
- [Get contacts from a segment](https://docs.esputnik.com/reference/getgroupcontacts-1.md): The method is used to search for all contacts in a segment.
- [Get contact import status](https://docs.esputnik.com/reference/getimportsessionstatus-1.md): The method is used for getting the status of the contact import session by the asynchronous ID of the session.
- [Search for contacts](https://docs.esputnik.com/reference/searchcontacts-1.md):
Search for contacts. The method returns max 500 results.
The total amount of contacts is in the TotalCount header.
- [Get segments](https://docs.esputnik.com/reference/searchgroups-1.md): The method searches for and returns the available segments.
- [Get workflows](https://docs.esputnik.com/reference/searchworkflows-1.md): The method searches for and returns the available workflows.
- [Subscribe a contact](https://docs.esputnik.com/reference/subscribecontact-1.md): The method is used for the integration of subscription forms.
If a contact does not exist, it is created with the non-confirmed email.
If a contact exists, the contact fields are updated (except existing media channels).
New contacts are created with a not confirmed status.
- [Update contact](https://docs.esputnik.com/reference/updatecontact-1.md): The method is used to update the contact's data, except for the contact ID field.
In case of updating a deleted contact, this contact is restored.
- [Add web push domains](https://docs.esputnik.com/reference/addwebpushdomains.md): The method is used for adding domains for web push notifications.
- [Generate event v2](https://docs.esputnik.com/reference/registerevent_1.md): Sends any backend events from websites and mobile apps to our system. Secure for sensitive data.For sending frontend events, mobile apps should use SDK.The request example is available at the link.
- NOTE: The maximum size of event data in the request body is 20 KB.
- [Generate events v1](https://docs.esputnik.com/reference/registerevent-1.md): The method is used for generating events in the account to be used for starting a workflow or being taken into account for segmentation.
Max. size of content for events sent in the request body is 20 kB.
To learn more, read Order management via events.
- [Generate past events V2](https://docs.esputnik.com/reference/sendhistoryevents_1.md): The method is used for transferring the available event data from your CRM or other data store to our system.
Workflows are not launched for these events. You can send up to 500 events per a request.
NOTE: Version 2 API methods do not require escaping in nested JSON.
Learn more.
- [Generate past events V1](https://docs.esputnik.com/reference/sendhistoryevents-1.md): The method is used for transferring the available event data from your CRM or other data store to our system.
The workflows are not launched for these events. You can send up to 500 events per a request.
Learn more.
- [Generate API token](https://docs.esputnik.com/reference/generateapikey-1.md): The method is used for generating a token for bearer authentication. Use the token only if the basic authentication is not appropriate for you.
Available methods for token authorization:
POST /v1/event
POST /v1/past_events
DELETE /v1/past_events
- [Generate event v3](https://docs.esputnik.com/reference/registerevent_2.md): Sends any backend events from websites and mobile apps to our system. Secure for sensitive data.For sending frontend events, mobile apps should use SDK.The request example is available at the link.- NOTE: The maximum size of event data in the request body is 20 KB.
- [Delete events](https://docs.esputnik.com/reference/removehistoryevents.md): The method is used for deleting events occurred during selected period.
- [Generate past events V3](https://docs.esputnik.com/reference/sendhistoryevents_2.md): The method is used for transferring the available event data from your CRM or other data store to our system.
Workflows are not launched for these events. You can send up to 500 events per a request.
NOTE: Version 3 API methods do not require escaping in nested JSON.
Learn more.
- [Add base App Inbox message](https://docs.esputnik.com/reference/addappinboxmessage.md): The method is used for creating basic App Inbox messages.
- [Add base Email message](https://docs.esputnik.com/reference/addemail-1.md): The method is used for adding/updating the language version of a message identified by the internal ID (for multilingual messages).
- [Add base Mobile Push message](https://docs.esputnik.com/reference/addmobilepushmessage.md): The method is used for creating new Mobile Push message.
- [Add base SMS message](https://docs.esputnik.com/reference/addsmsmessage.md): The method is used for creating basic SMS messages.
- [Add base Telegram bot message](https://docs.esputnik.com/reference/addtelegrambotmessage.md): The method is used for creating basic Telegram bot messages.
- [Add base Viber message](https://docs.esputnik.com/reference/addvibermessage.md): The method is used for creating base Viber message.
- [Create broadcast](https://docs.esputnik.com/reference/createbroadcast-1.md): The method is used for creating broadcasts for Email, SMS, Mobile Push, Web Push, Viber, Telegram channels.
- [Delete App Inbox message](https://docs.esputnik.com/reference/deleteappinboxmessage.md): The method is used for deleting the base App Inbox message.
- [Cancel scheduled broadcast](https://docs.esputnik.com/reference/deletebroadcast-1.md): The method is used for cancelling a scheduled broadcast.
- [Delete translated Email message](https://docs.esputnik.com/reference/deleteemail_1.md): The method is used for deleting the translation of the basic Email message.
- [Delete basic Email message](https://docs.esputnik.com/reference/deleteemail-1.md): The method is used for deleting the basic Email message.
- [Delete base Mobile Push message](https://docs.esputnik.com/reference/deletemobilepushmessage.md): The method is used for deleting the base Mobile Push message.
- [Delete SMS message](https://docs.esputnik.com/reference/deletesmsmessage.md): The method is used for deleting the base SMS message.
- [Delete Telegram bot message](https://docs.esputnik.com/reference/deletetelegrambotmessage.md): The method is used for deleting the base Telegram bot message.
- [Delete translated App Inbox message](https://docs.esputnik.com/reference/deletetranslatedappinboxmessage.md): The method is used for deleting the language version of the basic App Inbox message.
- [Delete language version of Mobile Push message](https://docs.esputnik.com/reference/deletetranslatedmobilepushmessage.md): The method is used for deleting the language version of the base Mobile Push message.
- [Delete translated SMS message](https://docs.esputnik.com/reference/deletetranslatedsmsmessage.md): The method is used for deleting the language version of the basic SMS message.
- [Delete translated Telegram bot message](https://docs.esputnik.com/reference/deletetranslatedtelegrambotmessage.md): The method is used for deleting the language version of the basic Telegram bot message.
- [Delete translated Viber message](https://docs.esputnik.com/reference/deletetranslatedvibermessage.md): The method is used for deleting language version of base Viber message.
- [Delete Viber message](https://docs.esputnik.com/reference/deletevibermessage.md): The method is used for deleting base Viber message.
- [Get broadcasts](https://docs.esputnik.com/reference/findbroadcasts-1.md): The method is used for getting a list of broadcasts.
- [Get the App Inbox message](https://docs.esputnik.com/reference/getappinboxmessage.md): The method returns the App Inbox message found using its ID. By default, a rate limit of 500 requests per hour applies.
- [Get broadcast info](https://docs.esputnik.com/reference/getbroadcast-1.md): The method is used for getting broadcast information.
- [Get Email message](https://docs.esputnik.com/reference/getemail-1.md): The method returns the content, title, and sender details of a message identified by the internal ID – html and css separately. By default, a rate limit of 500 requests per hour applies.
- [Get Email interfaces](https://docs.esputnik.com/reference/getemailinterfaces-1.md): The method is used for getting Email interfaces (sender names).
- [Get Email message view link](https://docs.esputnik.com/reference/getemailmessageviewlink-1.md): This method is used to get a link to view the Email message. By default, a rate limit of 500 requests per hour applies.
- [Get single message status](https://docs.esputnik.com/reference/getinstantmessagesstatus-1.md): The method is used for getting the status of a single message.
- [Get a Mobile Push message](https://docs.esputnik.com/reference/getmobilepushmessage.md): The method returns Mobile Push message including language versions. By default, a rate limit of 500 requests per hour applies.
- [Get promotional codes](https://docs.esputnik.com/reference/getpromocodes-1.md): The method returns a list of all available promotional codes as JSON string.
- [Get the number of available promotional codes](https://docs.esputnik.com/reference/getpromocodescount-1.md): The method returns the number of available promo codes.
- [Get SMS message](https://docs.esputnik.com/reference/getsms-1.md): The method returns content, title, sender and text of an SMS identified by its internal SMS message ID. By default, a rate limit of 500 requests per hour applies.
- [Get SMS interfaces](https://docs.esputnik.com/reference/getsmsinterfaces-1.md): The method is used for getting SMS interfaces (alpha names).
- [Get organization subscriptions](https://docs.esputnik.com/reference/getsubscriptioncategories-1.md): The method returns subscription categories for the organization.
- [Get the app Telegram bot message](https://docs.esputnik.com/reference/gettelegrambotmessage.md): The method returns the Telegram bot message found using its ID. By default, a rate limit of 500 requests per hour applies.
- [Get the Viber message](https://docs.esputnik.com/reference/getvibermessage.md): The method returns Viber message found by ID. By default, a rate limit of 500 requests per hour applies.
- [Upload promotional codes](https://docs.esputnik.com/reference/insertpromocodes.md): Upload promo codes from CSV or JSON.
Existing promotional codes are updated.
- [Get preprocessor file status](https://docs.esputnik.com/reference/preprocessorfilestatus-1.md): The method is used for retrieving the preprocessor file uploading session status using the asynchronous session identifier.
- [Update interaction status](https://docs.esputnik.com/reference/registerinteractionstatus-1.md): The method is used for sending message status using interaction_id.
This ID is sent along with data in a message.
Example for Mobile Push: "es_interaction_id": "2E2E831C-486C-41F9-8E8D-BCD6B7A51A7A".
- [Search for App Inbox messages](https://docs.esputnik.com/reference/searchappinboxmessages.md): The method is used to search for mobile App Inbox messages using a part of the name or a tag.
The method returns a maximum of 500 messages per request.
The TotalCount header contains the number of messages returned by the query.
- [Search for Email messages](https://docs.esputnik.com/reference/searchemails-1.md): The method is used to search for Email messages using a part of their name or a tag. By default, a rate limit of 500 requests per hour applies.
The method returns a maximum of 500 messages per request.
The TotalCount header contains the number of messages returned to the query.
- [Search for Mobile Push messages](https://docs.esputnik.com/reference/searchmobpushmessages.md): The method is used to search for Mobile Push messages using a part of name or a tag. By default, a rate limit of 500 requests per hour applies
The method returns a maximum of 500 messages per request.
The TotalCount header contains the number of messages returned by the query
- [Search for SMS messages](https://docs.esputnik.com/reference/searchsms-1.md): The method is used to search for SMS messages using a part of their names or a tag. By default, a rate limit of 500 requests per hour applies.
The method returns a maximum of 500 messages per request.
The TotalCount header contains the number of messages returned by the query.
- [Search for Telegram bot messages](https://docs.esputnik.com/reference/searchtelegrambotmessages.md): The method is used to search for Telegram bot messages using a part of name or a tag. By default, a rate limit of 500 requests per hour applies.
The method returns a maximum of 500 messages per request.
The TotalCount header contains the number of messages returned by the query.
- [Search for Viber messages](https://docs.esputnik.com/reference/searchvibermessages.md): The method is used to search for Viber messages using a part of name or a tag. By default, a rate limit of 500 requests per hour applies.
The method returns a maximum of 500 messages per request.
The TotalCount header contains the number of messages returned by the query
- [Send Email message](https://docs.esputnik.com/reference/sendemail-1.md): The method is used for sending an Email message to a contact. A new contact is created if no contact with such email address exists.
⚠️ Not recommended for OTP passwords. This method requires the full email HTML in the request body. Because of the content volume, such requests are not logged reliably, which makes delivery troubleshooting difficult.
Use the Send prepared message method instead: the caller only passes substitution variables, the template is stored on our side, so the message is sent faster and all requests are logged correctly.
- [Send prepared message](https://docs.esputnik.com/reference/sendextendedpreparedmessage-1.md): The method is used for sending a prepared message to one or many contacts. You can create broadcasts for Email, SMS, Mobile Push, Web Push, Viber, Telegram bot channels.
You can parametrize the message for each contact individually. Details >
- [Send SMS message](https://docs.esputnik.com/reference/sendsms-1.md): The method is used for sending an SMS message to a contact. A new contact is created if no contact with such phone number exists.
- [Send Viber message](https://docs.esputnik.com/reference/sendviber-1.md): The method is used for sending a Viber message to a contact. A new contact is created if no contact with such phone number exists. Supports carousel messages with 2-5 items containing images and buttons.
- [Update the base App Inbox message](https://docs.esputnik.com/reference/updatebaseappinboxmessage.md): The method is used for updating the base App Inbox message.
- [Update base Mobile Push message](https://docs.esputnik.com/reference/updatebasemobpushmessage.md): The method is used for updating the base Mobile Push message.
- [Update base SMS message](https://docs.esputnik.com/reference/updatebasesmsmessage.md): The method is used for updating the base SMS message.
- [Update base Telegram bot message](https://docs.esputnik.com/reference/updatebasetelegrambotmessage.md): The method is used for updating the base Telegram bot message.
- [Update base Viber message](https://docs.esputnik.com/reference/updatebasevibermessage.md): The method is used for updating base Viber message.
- [Add/update translated Email message](https://docs.esputnik.com/reference/updatemessage_1.md): The method is used for updating or adding language versions for the basic Email message.
- [Update basic Email message](https://docs.esputnik.com/reference/updatemessage-1.md): The method is used for updating the basic Email message.
- [Update file for preprocessor](https://docs.esputnik.com/reference/updatepreprocessorfile-1.md): The methods updates the data of a preprocessor file uploaded using the Upload file for preprocessor method.
To update the file, use the fileId value returned by the Upload file for preprocessor method in its response.
- [Add/update translated App Inbox message](https://docs.esputnik.com/reference/updatetranslatedappinboxmessage.md): The method is used for updating or adding language versions for the basic App Inbox message.
- [Add/update translated Mobile Push message](https://docs.esputnik.com/reference/updatetranslatedmobilepushmessage.md): The method is used for updating or adding language versions for the basic Mobile Push message.
- [Add/update translated Telegram message](https://docs.esputnik.com/reference/updatetranslatedtelegrambotmessage.md): The method is used for updating or adding language versions for the basic Telegram message.
- [Update translated SMS message](https://docs.esputnik.com/reference/updatetranslatesmsmessage.md): The method is used for updating the language version of SMS message.
- [Update translated Viber message](https://docs.esputnik.com/reference/updatetranslatevibermessage.md): The method is used for updating language version of base Viber message.
- [Upload file for preprocessor](https://docs.esputnik.com/reference/uploadpreprocessorfile-1.md): The method is used for uploading a file for the preprocessor from an external repository.
- [Add orders](https://docs.esputnik.com/reference/ordersbulkinsert-1.md): The method is used for transferring orders.
To learn more, read Order Transfer Using the Generate event API Method.
- [Delete orders](https://docs.esputnik.com/reference/removehistoryorders.md): This endpoint schedules an asynchronous order deletion job.
Supported deletion criteria:
• externalOrderId (deletes the order with the specified externalOrderId), or
• from and to (deletes orders whose occurrence timestamp falls within the specified period).
- [Configure product feeds](https://docs.esputnik.com/reference/configureproductfeeds.md)
- [Get product feeds configuration](https://docs.esputnik.com/reference/getproductfeedsconfiguration.md)
- [Add one web push domain](https://docs.esputnik.com/reference/addwebpushdomain.md): The method is used for adding one domain for web push notifications.
- [Add domain](https://docs.esputnik.com/reference/createdomain.md): The method registers the domain sent in the body params for use in web tracking or widgets.
Only one domain can be registered per organization.
- [Delete web push domain](https://docs.esputnik.com/reference/deletewebpushdomain.md): The method is used for deleting a domain for web push notifications.
- [Get domain](https://docs.esputnik.com/reference/getdomains.md): The method returns your organization's domain. The response is empty if no domain is found.
- [Get script](https://docs.esputnik.com/reference/getscript.md): The method returns the script for your account.
The domain must exist for an organization before getting a script.
It can be used for plugins that automatically install the script on the site and require the API endpoint for getting the script.
- [Get web push domains](https://docs.esputnik.com/reference/getwebpushdomains.md): The method returns the list of domains registered for web push notifications.
- [Get web push script](https://docs.esputnik.com/reference/getwebpushscript.md): The method returns the web push script for the specified domain.
- [Android App Inbox](https://docs.esputnik.com/reference/android-app-inbox.md)
- [Android Debug Mode](https://docs.esputnik.com/reference/android-debug-mode.md)
- [Android Ecommerce Activity Tracking](https://docs.esputnik.com/reference/android-ecommerce-activity-tracking.md)
- [Android In-App Messages Pause](https://docs.esputnik.com/reference/android-in-app-messages-pause.md)
- [Android In-App Messages](https://docs.esputnik.com/reference/android-in-app-messages.md)
- [Android Old Versions Support](https://docs.esputnik.com/reference/android-old-versions-support.md)
- [Android Push Notifications Integration Guide](https://docs.esputnik.com/reference/android-push-handling.md)
- [Android Recommendations](https://docs.esputnik.com/reference/android-recommendations.md)
- [Android SDK Integration Guide](https://docs.esputnik.com/reference/android-sdk-setup.md): The Reteno Android SDK for Mobile Customer Engagement and Analytics solutions.
- [Android User Behaviour](https://docs.esputnik.com/reference/android-user-behaviour.md)
- [Android User Information](https://docs.esputnik.com/reference/android-user-information.md)
- [Android App Lifecycle Events](https://docs.esputnik.com/reference/app-lifecycle-events.md)
- [In-App Lifecycle Callbacks](https://docs.esputnik.com/reference/in-app-lifecycle-callbacks.md)
- [Preventing Possible WorkManager Issues](https://docs.esputnik.com/reference/preventing-possible-workmanager-issues.md)
- [Setting Up Firebase Application for Firebase Cloud Messaging](https://docs.esputnik.com/reference/setting-up-your-firebase-application-for-firebase-cloud-messaging.md)
- [Cordova Action Buttons](https://docs.esputnik.com/reference/cordova-action-buttons.md)
- [Cordova Android SDK Setup](https://docs.esputnik.com/reference/cordova-android-sdk-setup.md)
- [Cordova App Inbox](https://docs.esputnik.com/reference/cordova-app-inbox.md)
- [Cordova App Lifecycle Events](https://docs.esputnik.com/reference/cordova-app-lifecycle-events.md)
- [Cordova Ecommerce Activity Tracking](https://docs.esputnik.com/reference/cordova-ecommerce-activity-tracking.md)
- [Cordova In-App Messages](https://docs.esputnik.com/reference/cordova-in-app-messages.md)
- [Cordova iOS SDK Setup](https://docs.esputnik.com/reference/cordova-ios-sdk-setup.md)
- [Cordova Recommendations](https://docs.esputnik.com/reference/cordova-recommendations.md)
- [Cordova User Behaviour](https://docs.esputnik.com/reference/cordova-user-behaviour.md)
- [Cordova User Information](https://docs.esputnik.com/reference/cordova-user-information.md)
- [Expo Action Buttons](https://docs.esputnik.com/reference/expo-action-buttons.md)
- [Expo Android SDK Setup](https://docs.esputnik.com/reference/expo-android-sdk-setup.md)
- [Expo App Inbox Messages](https://docs.esputnik.com/reference/expo-app-inbox-messages.md)
- [Expo App Lifecycle Events](https://docs.esputnik.com/reference/expo-app-lifecycle-events.md)
- [Expo Ecommerce Activity Tracking](https://docs.esputnik.com/reference/expo-ecommerce-activity-tracking.md)
- [Expo In-App Messages](https://docs.esputnik.com/reference/expo-in-app-messages.md)
- [Expo iOS SDK Setup](https://docs.esputnik.com/reference/expo-ios-sdk-setup.md)
- [Expo Push Handling](https://docs.esputnik.com/reference/expo-push-notifications.md)
- [Expo Recommendations](https://docs.esputnik.com/reference/expo-recommendations.md)
- [Expo Troubleshooting](https://docs.esputnik.com/reference/expo-troubleshooting.md)
- [Expo User Behaviour](https://docs.esputnik.com/reference/expo-user-behaviour.md)
- [Expo User Information](https://docs.esputnik.com/reference/expo-user-information.md)
- [Expo SDK](https://docs.esputnik.com/reference/expo-sdk.md)
- [Flutter Action Buttons](https://docs.esputnik.com/reference/flutter-action-buttons.md)
- [Flutter Android SDK Setup](https://docs.esputnik.com/reference/flutter-android-sdk-setup.md)
- [Flutter App Inbox Messages](https://docs.esputnik.com/reference/flutter-app-inbox-messages.md)
- [Flutter App Lifecycle Events](https://docs.esputnik.com/reference/flutter-app-lifecycle-events.md)
- [Flutter Ecommerce Activity Tracking](https://docs.esputnik.com/reference/flutter-ecommerce-activity-tracking.md)
- [Flutter In-App Messages Lifecycle Callbacks](https://docs.esputnik.com/reference/flutter-in-app-messages-lifecycle-callbacks.md)
- [Flutter iOS SDK Setup](https://docs.esputnik.com/reference/flutter-ios-sdk-setup.md)
- [Updating to Flutter Versions 1.9.0 +](https://docs.esputnik.com/reference/flutter-migration-guide.md)
- [Flutter Push Handling](https://docs.esputnik.com/reference/flutter-push-handling.md)
- [Flutter Recommendations](https://docs.esputnik.com/reference/flutter-recommendations.md)
- [Flutter User Behaviour](https://docs.esputnik.com/reference/flutter-user-behaviour.md)
- [Flutter User Information](https://docs.esputnik.com/reference/flutter-user-information.md)
- [Integrating Your App with eSputnik](https://docs.esputnik.com/reference/integrating-your-app-with-esputnik.md): How to connect mobile apps with eSputnik
- [Ionic Action Buttons](https://docs.esputnik.com/reference/ionic-action-buttons.md)
- [Ionic App Inbox Messages](https://docs.esputnik.com/reference/ionic-app-inbox-messages.md)
- [Ionic App Lifecycle Events](https://docs.esputnik.com/reference/ionic-app-lifecycle-events.md)
- [Ionic Ecommerce Activity Tracking](https://docs.esputnik.com/reference/ionic-ecommerce-activity-tracking.md)
- [Ionic In-App Messages](https://docs.esputnik.com/reference/ionic-in-app-messages.md)
- [Ionic Android SDK Setup](https://docs.esputnik.com/reference/ionic-ios-sdk-android.md)
- [Ionic iOS SDK Setup](https://docs.esputnik.com/reference/ionic-ios-sdk-setup.md)
- [Ionic Recommendations](https://docs.esputnik.com/reference/ionic-recommendations.md)
- [Ionic User Behaviour](https://docs.esputnik.com/reference/ionic-user-behaviour.md)
- [Ionic User Information](https://docs.esputnik.com/reference/ionic-user-information.md)
- [iOS App Inbox](https://docs.esputnik.com/reference/ios-app-inbox.md)
- [iOS App Lifecycle Events](https://docs.esputnik.com/reference/ios-app-lifecycle-events.md)
- [iOS Debug Mode](https://docs.esputnik.com/reference/ios-debug-mode.md)
- [iOS Ecommerce Activity Tracking](https://docs.esputnik.com/reference/ios-ecommerce-activity-tracking.md)
- [IOS SDK In-App Status Handler](https://docs.esputnik.com/reference/ios-sdk-in-app-status-handler.md)
- [iOS SDK In-Apps Pause](https://docs.esputnik.com/reference/ios-sdk-in-apps-pause.md)
- [iOS SDK Setup](https://docs.esputnik.com/reference/ios-sdk-setup.md): The Reteno iOS SDK for Mobile Customer Engagement and Analytics solutions
- [iOS User Behaviour](https://docs.esputnik.com/reference/ios-user-behaviour.md)
- [iOS User Information](https://docs.esputnik.com/reference/ios-user-information.md)
- [iOS Links Handler](https://docs.esputnik.com/reference/links-handler.md)
- [Location Enrichment for Mobile Events by IP](https://docs.esputnik.com/reference/location-enrichment-for-mobile-events-by-ip.md)
- [Managing Mobile SDK Access Keys](https://docs.esputnik.com/reference/managing-mobile-sdk-access-keys.md)
- [React Native App Lifecycle Events](https://docs.esputnik.com/reference/app-lifecycle-events-1.md)
- [React Native Android SDK Setup](https://docs.esputnik.com/reference/react-native-android-sdk-setup.md)
- [React Native App Inbox Messages](https://docs.esputnik.com/reference/react-native-app-inbox-messages.md)
- [React Native Ecommerce Activity Tracking](https://docs.esputnik.com/reference/react-native-ecommerce-activity-tracking.md)
- [React Native In-App Messages](https://docs.esputnik.com/reference/react-native-in-app-messages.md)
- [React Native iOS SDK Setup](https://docs.esputnik.com/reference/react-native-ios-sdk-setup.md)
- [React Native Push Notification](https://docs.esputnik.com/reference/react-native-push-notification.md)
- [React Native Recommendations](https://docs.esputnik.com/reference/react-native-recommendations.md)
- [React Native User Behaviour](https://docs.esputnik.com/reference/react-native-tracking-user-behaviour.md)
- [React Native User Information](https://docs.esputnik.com/reference/react-native-user-information.md)
- [React Native Action Buttons](https://docs.esputnik.com/reference/react-nativeaction-buttons.md)
- [SDK Release Notes](https://docs.esputnik.com/reference/sdk-release-notes.md)
- [Unity SDK Setup](https://docs.esputnik.com/reference/unity-sdk-setup.md): Reteno Unity Plugin Documentation
- [Unity User Information](https://docs.esputnik.com/reference/tracking-user-information.md)
- [Unity Android SDK Setup](https://docs.esputnik.com/reference/unity-android-sdk-setup.md): Getting started with Reteno Plugin for Android
- [Unity Event Management](https://docs.esputnik.com/reference/unity-event-management.md)
- [Unity Example Project](https://docs.esputnik.com/reference/unity-example-project.md)
- [Unity In-App Messages](https://docs.esputnik.com/reference/unity-in-app-messages.md)
- [Unity Initialization](https://docs.esputnik.com/reference/unity-initialization.md)
- [Unity iOS SDK Setup](https://docs.esputnik.com/reference/unity-ios-sdk-setup.md)
- [Unity Notifications](https://docs.esputnik.com/reference/unity-notifications-module.md)
- [Unity Push Handling](https://docs.esputnik.com/reference/unity-push-handling.md)
- [Unity Recommendations](https://docs.esputnik.com/reference/unity-recommendations-module.md)
- [Unity Troubleshooting & FAQ](https://docs.esputnik.com/reference/unity-troubleshooting-faq.md)
- [Unity User Behaviour](https://docs.esputnik.com/reference/unity-user-behaviour.md)
- [Unity User Management](https://docs.esputnik.com/reference/unity-user-management.md)
## Pages
- [Android SDK Release Notes](https://docs.esputnik.com/android-sdk-release-notes.md)
- [Cordova SDK Release Notes](https://docs.esputnik.com/cordova-sdk-release-notes.md)
- [Expo SDK Release Notes](https://docs.esputnik.com/expo-sdk-release-notes.md)
- [Flutter SDK Release Notes](https://docs.esputnik.com/flutter-sdk-release-notes.md)
- [Ionic SDK Release Notes](https://docs.esputnik.com/ionic-sdk-release-notes.md)
- [iOS SDK Release Notes](https://docs.esputnik.com/ios-sdk-release-notes.md)
- [React Native SDK Release Notes](https://docs.esputnik.com/react-native-sdk-release-notes.md)
- [Unity SDK Release Notes](https://docs.esputnik.com/unity-sdk-release-notes.md)