- Category: marketing automation
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 89
- Triggers: 0
- Slug:
ESPUTNIK - Version: 20261101_00
Tools
Add Contact
Add Contact
ESPUTNIK_ADD_CONTACTAdd or update a single eSputnik contact, matching existing contacts by channel; new contacts are treated as confirmed. Contact processing is asynchronous, so acceptance does not mean the data is already saved.Input Parameters
Output
Add Domain
Add Domain
ESPUTNIK_ADD_DOMAINRegister a domain with eSputnik for web tracking, widgets, or web push notifications. This tool is used to add a new domain to your eSputnik account, enabling: - Website behavior tracking for personalization - Widget integration (pop-ups, subscription forms) - Web push notification configuration Prerequisites: - Valid eSputnik API credentials with appropriate permissions - Domain ownership or administrative access to configure tracking Returns the registered domain and associated site identifier.Input Parameters
Output
Add Orders Bulk
Add Orders Bulk
Add Unsubscribed Emails
Add Unsubscribed Emails
ESPUTNIK_ADD_UNSUBSCRIBED_EMAILSAdd email addresses to the unsubscribed list. All contacts in the organization using those addresses stop receiving bulk emails; other channels remain active.Input Parameters
Output
Add Web Push Domain
Add Web Push Domain
ESPUTNIK_ADD_WEBPUSH_DOMAINTool to add a domain for web push notifications in eSputnik. Use when you need to register a new domain to enable web push notification functionality. The domain must be reachable and not already registered in your account. This operation configures the service worker settings required for web push notifications to function. Prerequisites: - Valid eSputnik API credentials with appropriate permissions - Domain ownership or administrative access - Service worker JavaScript file prepared for deploymentInput Parameters
Output
Attach Contacts to Segment
Attach Contacts to Segment
ESPUTNIK_ATTACH_CONTACTS_TO_SEGMENTTool to attach contacts to a static segment (group) by contact IDs or external customer IDs. Use this action to add contacts to a static segment for organizing and targeting your contact lists. You can specify contacts using either eSputnik internal contact IDs or your own external customer IDs. Maximum 500 contacts per request.Input Parameters
Output
Bulk Add or Update Contacts
Bulk Add or Update Contacts
ESPUTNIK_BULK_ADD_OR_UPDATE_CONTACTSBulk add or update up to 3,000 contacts asynchronously, matching on the selected deduplication channel; new contacts are treated as confirmed. The response may include an async session ID for tracking import progress and details of failed contacts.Input Parameters
Output
Change Mobile Push Token Activity
Change Mobile Push Token Activity
ESPUTNIK_CHANGE_TOKEN_ACTIVITYActivate or deactivate a registered eSputnik mobile push token for an application to control whether a device can receive push notifications. Specify the application UUID, device token and desired activity state.Input Parameters
Output
Create API Token
Create API Token
Create App Inbox Message
Create App Inbox Message
ESPUTNIK_CREATE_APP_INBOX_MESSAGETool to create a basic App Inbox message in eSputnik. Use when you need to create a new in-app notification message. App Inbox messages are displayed within mobile apps or websites as notifications to users. Requires at minimum a name, title, and text. Optionally supports images, links, custom data, translations for multiple languages, tags, and subscription categories.Input Parameters
Output
Create Contacts from File
Create Contacts from File
ESPUTNIK_CREATE_CONTACTS_FILEImport or update contacts from an external file in eSputnik. Creates new contacts and updates existing ones based on dedupeOn field. Use this action to bulk import contacts from a CSV file hosted at a publicly accessible URL. The file must use comma delimiters and follow eSputnik’s column naming requirements (firstName, lastName, email, sms, etc.). The import is asynchronous - use the returned asyncSessionId with Get Contact Import Status to monitor progress.Input Parameters
Output
Create Email Message
Create Email Message
ESPUTNIK_CREATE_EMAIL_MESSAGETool to create or update an email message in eSputnik. Use when you need to add a new email template or update an existing one, including support for multilingual message versions. When ‘id’ is provided in the request, the action updates the existing message with that ID. When ‘id’ is omitted, a new email message is created. The ‘languageCode’ parameter allows adding or updating specific language versions for multilingual campaigns.Input Parameters
Output
Create Mobile Push Message
Create Mobile Push Message
ESPUTNIK_CREATE_MOBILE_PUSH_MESSAGETool to create a new mobile push notification message in eSputnik. Use when you need to set up a push notification campaign for mobile app users. The created message can include title, body text, images, action buttons, and custom data. Supports multilingual messages through the translations field. After creation, use the returned message ID to send the notification to specific contacts or segments.Input Parameters
Output
Create SMS Message
Create SMS Message
ESPUTNIK_CREATE_SMS_MESSAGETool to create a basic SMS message template in eSputnik. Use when you need to create a new SMS message template for sending campaigns. The created template can be used later for sending SMS messages to contacts. Before creating an SMS message, ensure you have configured SMS interfaces (sender names) in your eSputnik account.Input Parameters
Output
Create Telegram Message
Create Telegram Message
ESPUTNIK_CREATE_TELEGRAM_MESSAGECreate a basic Telegram bot message in eSputnik. Use when you need to create a new message template that can be sent to contacts via Telegram. The message is saved as a template in eSputnik and can later be sent to contacts using the Send Message API. The message ID returned in the response is required for sending operations. Prerequisites: - Valid eSputnik API credentials with write permissions - Telegram bot configured in your eSputnik account Example usage: “Create a Telegram message with name ‘Welcome Message’ and text ‘Hello!’”Input Parameters
Output
Delete App Inbox Message
Delete App Inbox Message
ESPUTNIK_DELETE_APP_INBOX_MESSAGETool to delete an App Inbox message by its ID from eSputnik. Use when you need to permanently remove an App Inbox message that is no longer needed.Input Parameters
Output
Delete App Inbox Translation
Delete App Inbox Translation
ESPUTNIK_DELETE_APPINBOX_TRANSLATIONDelete a language translation of an App Inbox message from eSputnik. Use this action to remove a specific language version of an App Inbox message while keeping the base message and other translations intact. This is useful when you no longer need to support a particular language or need to clean up outdated translations. Prerequisites: - The App Inbox message must exist - The specified language translation must exist for the message - Valid eSputnik API credentials with write permissionsInput Parameters
Output
Delete Broadcast
Delete Broadcast
Delete Contact
Delete Contact
ESPUTNIK_DELETE_CONTACTTool to delete a contact by its Yespo ID. Use when you need to remove a contact with no pending interactions.Input Parameters
Output
Delete Contact by External ID
Delete Contact by External ID
ESPUTNIK_DELETE_CONTACT_BY_EXTERNAL_IDDelete a contact from eSputnik using their external customer ID. Use this tool when you need to remove a contact identified by the externalCustomerId (the unique ID from your external system, e.g., CRM or database). This is useful when you don’t have the eSputnik internal contact ID but do have the external reference. For GDPR compliance, set erase=true to permanently remove all contact data including activity history and tracking data.Input Parameters
Output
Delete Email Message
Delete Email Message
ESPUTNIK_DELETE_EMAIL_MESSAGEDelete a basic email message by its ID from eSputnik. Use this action to permanently remove an email message that is no longer needed. This is a destructive operation - the message will be permanently deleted and cannot be recovered. Prerequisites: - The email message must exist - Valid eSputnik API credentials with write permissions Example usage: “Delete email message 2345678”, “Remove email with ID 12345”Input Parameters
Output
Delete Email Translation
Delete Email Translation
ESPUTNIK_DELETE_EMAIL_TRANSLATIONDelete a translation of a base email message from eSputnik. Use this action to remove a specific language translation of an email message template. This does not delete the base email message, only the specified translation. The operation is permanent and the translation cannot be recovered once deleted. Prerequisites: - The email message must exist - The specified language translation must exist - Valid eSputnik API credentials with write permissions Example usage: “Delete Spanish translation of email 4404258”, “Remove French translation for email message 12345”Input Parameters
Output
Delete Mobile Push Message
Delete Mobile Push Message
ESPUTNIK_DELETE_MOBILEPUSH_MESSAGEDelete a base Mobile Push message by its ID from eSputnik. Use this action to permanently remove a Mobile Push message that is no longer needed. This is a destructive operation - the message will be permanently deleted and cannot be recovered. Prerequisites: - The Mobile Push message must exist - Valid eSputnik API credentials with write permissions Example usage: “Delete Mobile Push message 4404238”, “Remove push notification with ID 2345678”Input Parameters
Output
Delete Mobile Push Translation
Delete Mobile Push Translation
ESPUTNIK_DELETE_MOBILEPUSH_TRANSLATIONDelete a language version of a base Mobile Push message from eSputnik. Use this tool to remove a specific language translation from a mobile push message while keeping the base message and other translations intact. This is useful when managing multilingual campaigns and needing to remove or update specific language versions.Input Parameters
Output
Delete Orders
Delete Orders
ESPUTNIK_DELETE_ORDERSTool to schedule asynchronous deletion of orders in eSputnik. Use when you need to delete orders by external ID or by date range. Deletion can be performed by: - Specific order: Provide externalOrderId to delete a single order - Date range: Provide both ‘from’ and ‘to’ parameters to delete all orders within the specified period The deletion is asynchronous - the API accepts the request and processes it in the background.Input Parameters
Output
Delete SMS Message
Delete SMS Message
ESPUTNIK_DELETE_SMS_MESSAGEDelete a base SMS message template by its ID from eSputnik. Use this action to permanently remove an SMS message template that is no longer needed. This is a destructive operation - the template will be permanently deleted and cannot be recovered. Prerequisites: - The SMS message template must exist - Valid eSputnik API credentials with write permissions Example usage: “Delete SMS template 12345”, “Remove SMS message with ID 67890”Input Parameters
Output
Delete SMS Translation
Delete SMS Translation
ESPUTNIK_DELETE_SMS_TRANSLATIONDelete a language version of a base SMS message from eSputnik. Use this action to remove a specific language translation of an SMS message while keeping the base message and other translations intact. This is useful for removing outdated or incorrect translations. Prerequisites: - The base SMS message must exist - The specified language translation must exist for that message - Valid eSputnik API credentials with write permissions Example usage: “Delete Spanish translation of SMS message 4404242”, “Remove French version of SMS 12345”Input Parameters
Output
Delete Telegram Message
Delete Telegram Message
ESPUTNIK_DELETE_TELEGRAM_MESSAGEDelete a base Telegram bot message by its ID from eSputnik. Use this action to permanently remove a Telegram bot message that is no longer needed. This is a destructive operation - the message will be permanently deleted and cannot be recovered. Prerequisites: - The Telegram bot message must exist - Valid eSputnik API credentials with write permissions Example usage: “Delete Telegram message 4404236”, “Remove Telegram bot message with ID 12345”Input Parameters
Output
Delete Telegram Translation
Delete Telegram Translation
ESPUTNIK_DELETE_TELEGRAM_TRANSLATIONDelete a language version of a Telegram bot message from eSputnik. Use this action to remove a specific language translation of a Telegram bot message while keeping the base message and other translations intact. This is useful for managing multilingual bot messages when a translation is no longer needed or needs to be recreated.Input Parameters
Output
Detach Contacts from Segment
Detach Contacts from Segment
ESPUTNIK_DETACH_CONTACTS_FROM_SEGMENTRemove contacts from a static segment by internal contact IDs or external customer IDs, with at most 500 entries per ID list. If neither list is specified, all contacts are removed from the segment.Input Parameters
Output
Generate Event V2
Generate Event V2
ESPUTNIK_GENERATE_EVENT_V2Tool to send backend events from websites and mobile apps to eSputnik. Use when tracking user actions, page views, or custom events for marketing automation and analytics. Secure for sensitive data with maximum 20 KB event data limit.Input Parameters
Output
Generate Event V3
Generate Event V3
ESPUTNIK_GENERATE_EVENT_V3Tool to generate events in eSputnik v3 API. Use when you need to track custom events for contacts (e.g., purchase, cart abandoned, page viewed). Events can be used to trigger automated campaigns and for creating dynamic content in messages. Each event must have an eventTypeKey identifier. Contact identification must be provided in the params object using standard contact identifiers (email, phone, or externalCustomerId). Additional event parameters can also be included in params. Note: This is the v3 API endpoint. For legacy integrations, v1 is available but deprecated.Input Parameters
Output
Generate Past Events V2
Generate Past Events V2
ESPUTNIK_GENERATE_PAST_EVENTS_V2Tool to transfer past event data from your CRM or data store to eSputnik using v2 API. Use when you need to import historical events that should not trigger workflows. This method allows sending up to 500 events per request with a maximum content size of 20KB. Version 2 API methods do not require escaping in nested JSON, making it easier to work with complex event parameters. Workflows are not launched for these historical events.Input Parameters
Output
Generate Past Events V3
Generate Past Events V3
ESPUTNIK_GENERATE_PAST_EVENTS_V3Tool to generate past events in eSputnik v3 API. Use when you need to create historical events for contacts with specific timestamps. This action allows you to import past events with their original occurrence timestamps. Events can be used to trigger automated campaigns and for creating dynamic content in messages. Each event must have an eventTypeKey identifier and a keyValue for contact identification.Input Parameters
Output
Get Account Info
Get Account Info
ESPUTNIK_GET_ACCOUNT_INFORetrieve basic eSputnik account information. Use this tool to verify API authentication and get account details including the username/email and organization name. This is useful for confirming that API credentials are valid and retrieving account identifiers. Returns: - User email or username associated with the API key - Organization name for the authenticated account No parameters required - uses the authenticated account credentials automatically. This is a read-only, idempotent operation that can be called multiple times safely.Output
Get App Inbox Message
Get App Inbox Message
ESPUTNIK_GET_APP_INBOX_MESSAGERetrieves an App Inbox message by its unique identifier from eSputnik. Use this tool to fetch message content, metadata, and localized translations before sending, editing, or reviewing an App Inbox notification. Returns complete message details including title, text, images, links, and custom data for all configured language versions. Rate limit: 500 requests per hour.Input Parameters
Output
Get Broadcasts
Get Broadcasts
ESPUTNIK_GET_BROADCASTSRetrieve a paginated list of broadcast campaigns from eSputnik. Use this tool to: - List all scheduled or sent broadcast campaigns - Check broadcast details including target segments and scheduling - Navigate through broadcasts using pagination (startindex + maxrows) Returns broadcast details including IDs, titles, message templates, target segments, and scheduling information. Results are paginated - use startindex and maxrows to navigate through large lists. No filtering parameters supported - returns all broadcasts sorted by the API’s default order.Input Parameters
Output
Get Contact
Get Contact
ESPUTNIK_GET_CONTACTRetrieve a contact by its internal eSputnik ID, including available profile details, supported communication channels, and custom fields. The response does not include an explicit subscription status.Input Parameters
Output
Get Contact Emails
Get Contact Emails
ESPUTNIK_GET_CONTACT_EMAILSTool to retrieve email addresses of contacts by their contact IDs. Use when you need to fetch email addresses for specific contacts using their internal eSputnik identifiers. The API returns email addresses for all valid contact IDs provided. If a contact ID doesn’t exist, it will be omitted from the results (no error raised).Input Parameters
Output
Get Contact Import Status
Get Contact Import Status
Get Contact Message History
Get Contact Message History
ESPUTNIK_GET_CONTACT_MESSAGE_HISTORYRetrieve a contact’s message history across multiple channels from eSputnik. This action returns message history for a specific contact, supporting multiple media types: Email, SMS, Viber, Mobile Push, Web Push, App Inbox, and Telegram. Use this when you need to: - Review all messages sent to a contact within a date range - Track message delivery status and engagement metrics - Audit communication history for compliance or support purposes - Filter messages by specific channel types At least one contact identifier (contactId, externalCustomerId, email, or phone) must be provided. Results are paginated using offset and maxrows parameters.Input Parameters
Output
Get Contacts
Get Contacts
ESPUTNIK_GET_CONTACTSSearch for contacts in eSputnik using various filter criteria. Use this action to find contacts by email, phone number, name, external ID, or retrieve all contacts with pagination. Returns up to 500 contacts per request. The response includes contact details such as contactId, channels, custom fields, and segment membership. Use this when you need to: - Find a contact by email or phone number - Retrieve contacts by your external system ID - List all contacts with pagination (use startindex and maxrows) - Get contact details including their segments and custom fields For searches without filter conditions, use sortBy=‘contactId’ for faster results. Check the total_count field to determine if there are more results beyond the 500 limit.Input Parameters
Output
Get Contact Subscriptions
Get Contact Subscriptions
ESPUTNIK_GET_CONTACT_SUBSCRIPTIONSRetrieve all subscription categories a contact is enrolled in. This action returns the list of subscription categories (communication types) that a specific contact has opted into within your eSputnik account. Subscription categories typically represent different types of communications like newsletters, promotions, transactional emails, etc. Use this action when you need to: - Check which communication types a contact has subscribed to - Verify a contact’s subscription preferences before sending campaigns - Audit contact subscription status for compliance purposes - Build conditional logic based on subscription preferences Returns an empty array if the contact exists but has no active subscriptions. Returns a 404 error if the contact ID does not exist in the system.Input Parameters
Output
Get Email Interfaces
Get Email Interfaces
ESPUTNIK_GET_EMAIL_INTERFACESTool to retrieve all configured email interfaces (sender names) from eSputnik. Use when you need to list available email sender addresses/names before sending campaigns or messages. Returns a list of all email sender interfaces configured for the organization, including sender names, email addresses, and their active status. This information is useful when setting up email campaigns to ensure valid sender interfaces are used.Output
Get Email Message
Get Email Message
Get Email View Link
Get Email View Link
ESPUTNIK_GET_EMAIL_VIEW_LINKGet a link to view an email message in browser from eSputnik. Use this action to retrieve a public URL that displays the email message content in a web browser. This is useful for sharing email previews, testing message rendering, or providing a web version of the email to recipients. Rate limit: 500 requests per hour (default).Input Parameters
Output
Get Message Status
Get Message Status
ESPUTNIK_GET_MESSAGE_STATUSRetrieve delivery status for single messages sent through the eSputnik API using comma-separated request IDs returned by send operations. Results may include delivery state and other available tracking details.Input Parameters
Output
Get Mobile Push Message
Get Mobile Push Message
ESPUTNIK_GET_MOBILE_PUSH_MESSAGERetrieves an eSputnik mobile push message by ID, returning available message fields such as title, text, time-to-live and sound settings.Input Parameters
Output
Get Organization Balance
Get Organization Balance
Get Organization Billing History
Get Organization Billing History
ESPUTNIK_GET_ORGANIZATION_BILLING_HISTORYRetrieve the organization’s billing history from eSputnik, broken down by day and media channel. Use this tool to: - View costs per messaging channel (email, SMS, Viber, push notifications, etc.) - Track message volumes and spending over time - Analyze bonus credits usage and fund withdrawals - Generate billing reports for specific date ranges Returns daily breakdowns including messages sent, funds spent, and bonuses used per channel.Input Parameters
Output
Get Preprocessor File Status
Get Preprocessor File Status
ESPUTNIK_GET_PREPROCESSOR_FILE_STATUSRetrieve the status of an asynchronous preprocessor file upload session using its session ID. The response includes the HTTP status code and raw response text, including when the API returns an HTTP error.Input Parameters
Output
Get Product Feeds Configuration
Get Product Feeds Configuration
Get Promocodes Count
Get Promocodes Count
ESPUTNIK_GET_PROMOCODES_COUNTGet the number of available promotional codes in eSputnik. Use this action to check how many promo codes are available, optionally filtering by type, active due days, or discount amount.Input Parameters
Output
Get Site Domain
Get Site Domain
Get Site Tracking Script
Get Site Tracking Script
ESPUTNIK_GET_SITE_SCRIPTRetrieve the site tracking script for your eSputnik account. Use this tool to obtain the tracking script code that can be embedded on websites to enable eSputnik tracking and functionality. The domain must be configured in your organization before requesting the script. This is particularly useful for plugins that automatically install scripts and need programmatic access to the tracking code. Returns the complete tracking script as plain text ready for website integration. No parameters required - uses the authenticated account credentials automatically. This is a read-only, idempotent operation that can be called multiple times safely.Output
Get SMS Interfaces
Get SMS Interfaces
ESPUTNIK_GET_SMS_INTERFACESRetrieve all SMS interfaces (alpha names) configured for the organization. Use this tool to get the list of available SMS sender identifiers (alpha names) that can be used when sending SMS messages through eSputnik. Alpha names are pre-configured sender IDs that recipients see as the message sender. This is useful when: - You need to select a specific sender ID for SMS campaigns - You want to list all available SMS sending options - You need to verify which alpha names are configured and active No parameters required - returns all SMS interfaces for the authenticated account.Output
Get Subscription Categories
Get Subscription Categories
ESPUTNIK_GET_SUBSCRIPTION_CATEGORIESRetrieve all subscription categories for the organization. This action returns the complete list of subscription categories (communication types) configured in your eSputnik account. Subscription categories typically represent different types of communications like newsletters, promotions, transactional emails, etc. Use this action when you need to: - List all available subscription types in your eSputnik account - Get category IDs and keys for use in other API calls - Understand the structure of subscription options available to contacts - Build subscription management interfaces Returns an empty array if no subscription categories are configured. This is a read-only, idempotent operation that can be called multiple times safely.Output
Get Telegram Message
Get Telegram Message
ESPUTNIK_GET_TELEGRAM_MESSAGERetrieve a Telegram bot message by its unique identifier from eSputnik. Use this tool to fetch Telegram bot message content, configuration, and metadata before sending, editing, or reviewing a notification. Returns complete message details including text, formatting, keyboard markup, and notification settings. Rate limit: 500 requests per hour.Input Parameters
Output
List Promotional Codes
List Promotional Codes
ESPUTNIK_LIST_PROMOCODESRetrieve a list of promotional codes from eSputnik. Use this tool to view all available promo codes, filter by type, usage status, expiration, or discount value. Useful for campaign planning and promo code management.Input Parameters
Output
List Web Push Domains
List Web Push Domains
ESPUTNIK_LIST_WEBPUSH_DOMAINSRetrieve the list of domains registered for web push notifications. Use this tool to get all domains configured in your eSputnik account for web push notification functionality. This is useful for verifying domain registration status and managing web push notification configurations. Returns a list of domain names that have been registered. No parameters required - uses the authenticated account credentials automatically. This is a read-only, idempotent operation that can be called multiple times safely.Output
Remove From Unsubscribed
Remove From Unsubscribed
ESPUTNIK_REMOVE_FROM_UNSUBSCRIBEDTool to remove email addresses from the unsubscribed contacts list in eSputnik. Use when you need to re-enable email addresses that were previously unsubscribed.Input Parameters
Output
Search App Inbox Messages
Search App Inbox Messages
ESPUTNIK_SEARCH_APP_INBOX_MESSAGESSearch for mobile App Inbox messages using a part of the name or a tag. Returns a maximum of 500 messages per request with pagination support. Use this tool to find App Inbox messages by name or tag, list all available messages, or navigate through large message lists using pagination. The TotalCount header indicates the number of messages returned by the search query.Input Parameters
Output
Search Contacts
Search Contacts
ESPUTNIK_SEARCH_CONTACTSSearch for all contacts in a segment (group). Use this action to: - Retrieve contacts from a specific segment by segment ID - Paginate through large contact lists using startindex and maxrows - Sort contacts by addition time to the segment or by default order - Export contact lists from segments for analysis or sync purposes The API returns a list of contact objects with their channels, names, addresses, and custom fields. Results can be paginated using startindex and maxrows parameters. Maximum 500 contacts per request.Input Parameters
Output
Search Email Messages
Search Email Messages
ESPUTNIK_SEARCH_EMAIL_MESSAGESSearch for email messages using a part of their name or a tag. Use this tool to: - Find email messages by name or tag - List all available email message templates - Navigate through messages using pagination (startindex + maxrows) The method returns a maximum of 500 messages per request. The TotalCount header contains the total number of messages returned to the query. By default, a rate limit of 500 requests per hour applies.Input Parameters
Output
Search Mobile Push Messages
Search Mobile Push Messages
ESPUTNIK_SEARCH_MOBILEPUSH_MESSAGESSearch for mobile push messages using part of the name or a tag. Use this tool to: - Find mobile push messages by searching for keywords in message names - Filter messages by tags assigned to them - Retrieve all mobile push messages when no search criteria provided - Navigate through large result sets using pagination (startindex + maxrows) Returns up to 500 messages per request. The TotalCount header indicates the total number of messages matching your query. Rate limit: 500 requests per hour.Input Parameters
Output
Search Segments
Search Segments
ESPUTNIK_SEARCH_SEGMENTSSearch for and retrieve available segments (groups) in eSputnik. Use this action to: - List all segments/groups in your eSputnik account - Search for segments by name (supports partial matching) - Paginate through large segment lists using startindex and maxrows - Get segment IDs for use in other API calls (e.g., adding contacts to segments) Segments are groups of contacts that can be static (manually managed), dynamic (rule-based), or combined (mix of both). The API returns segment details including ID, name, and type. Maximum 500 segments per request.Input Parameters
Output
Search SMS Messages
Search SMS Messages
ESPUTNIK_SEARCH_SMS_MESSAGESSearch eSputnik SMS message templates by name or tag, with pagination and up to 500 requested per page. Returns the total count when a usable TotalCount response header is present.Input Parameters
Output
Search Telegram Messages
Search Telegram Messages
ESPUTNIK_SEARCH_TELEGRAM_MESSAGESSearch eSputnik Telegram bot messages by name or tag, with pagination and up to 500 requested per page. Returns message details and the total count when a usable TotalCount response header is present.Input Parameters
Output
Search Viber Messages
Search Viber Messages
ESPUTNIK_SEARCH_VIBER_MESSAGESSearch for Viber messages using part of the name or a tag. Use this tool to: - Find Viber messages by searching for keywords in message names - Filter messages by tags assigned to them - Retrieve all Viber messages when no search criteria provided - Navigate through large result sets using pagination (startindex + maxrows) Returns up to 500 messages per request. The TotalCount header indicates the total number of messages matching your query. Rate limit: 500 requests per hour.Input Parameters
Output
Search Workflows
Search Workflows
ESPUTNIK_SEARCH_WORKFLOWSSearch for and retrieve available workflows from eSputnik. Use this tool to list all workflows in your eSputnik account, with optional filtering by workflow name. Returns workflow details including IDs, names, statuses, and timestamps. Results are paginated - use startindex and maxrows to navigate through large lists.Input Parameters
Output
Send Email
Send Email
ESPUTNIK_SEND_EMAILSend an email to one or more addresses via eSputnik, with HTML and optional plain text, AMP content, and URL tracking; missing recipient contacts are automatically created. Multiple addresses are processed as separate sends, not as a single bulk campaign report.Input Parameters
Output
Send Prepared Message
Send Prepared Message
ESPUTNIK_SEND_PREPARED_MESSAGETool to send a prepared message to one or many contacts. Use when you need to send broadcasts for Email, SMS, Mobile Push, Web Push, Viber, or Telegram bot channels using pre-created message templates. The method allows sending to up to 1,000 recipients in a single request. You can parametrize the message for each contact individually using jsonParam field for personalization. Recipients can be identified by contactId (eSputnik internal ID) or locator (email/phone).Input Parameters
Output
Subscribe Contact
Subscribe Contact
ESPUTNIK_SUBSCRIBE_CONTACTTool to subscribe a contact for double opt-in implementation. Use when integrating subscription forms on your website or app. This method is designed for double opt-in implementation: - If a contact does not exist, it is created with a non-confirmed email status - If a contact exists, the contact fields are updated (except existing media channels) - New contacts are created with a not confirmed status and cannot receive bulk emails until they confirm their subscription - However, unconfirmed contacts are available for receiving important trigger messages - An event is automatically generated after this method is called, which can be used to send confirmation emails via campaigns - When clicking the confirmation link, a contact becomes confirmed and available for bulk emails Note: This differs from bulk contact import - contacts created here are unconfirmed by default.Input Parameters
Output
Update App Inbox Message
Update App Inbox Message
Update App Inbox Translation
Update App Inbox Translation
ESPUTNIK_UPDATE_APPINBOX_TRANSLATIONTool to update or add a language version for an App Inbox message in eSputnik. Use when you need to add multilingual support or update existing translations for App Inbox notifications. This action allows updating the title, text, link, image, and other properties for a specific language version of an App Inbox message. If the language version doesn’t exist, it will be created; if it exists, it will be updated with the new content.Input Parameters
Output
Update Contact
Update Contact
ESPUTNIK_UPDATE_CONTACTTool to update contact information by contact ID. Use when you need to modify an existing contact’s details. This action updates an existing contact identified by their eSputnik contact ID. You can update any combination of contact fields including name, channels, address, and custom fields. Only the fields you provide will be updated; other fields remain unchanged.Input Parameters
Output
Update Contact Subscriptions
Update Contact Subscriptions
ESPUTNIK_UPDATE_CONTACT_SUBSCRIPTIONSTool to update the subscription categories a contact is enrolled in. Use when you need to modify which communication types a contact receives. This action replaces the contact’s current subscription list with the provided categories. Pass an empty array to unsubscribe from all categories. Returns success if the contact exists.Input Parameters
Output
Update Email Message
Update Email Message
ESPUTNIK_UPDATE_EMAIL_MESSAGETool to update an existing email message in eSputnik. Use when you need to modify the content, subject, sender, or other properties of an existing email template. This action updates the basic email message properties including HTML content, subject line, sender information, and optional fields like AMP HTML, CSS styles, and subscription categories. The ‘languageCode’ parameter allows updating specific language versions for multilingual campaigns.Input Parameters
Output
Update Email Translation
Update Email Translation
ESPUTNIK_UPDATE_EMAIL_TRANSLATIONTool to update or add a language version for a base email message in eSputnik. Use when you need to add multilingual support to an existing email template or update an existing translation. This action updates the translation for a specific language of an existing email message. If the translation for the specified language doesn’t exist, it will be created. The base message must already exist in eSputnik.Input Parameters
Output
Update Interaction Status
Update Interaction Status
ESPUTNIK_UPDATE_INTERACTION_STATUSTool to update the status of a message interaction using interaction_id. Use when you need to report message delivery, open, click, or undelivery events. The interaction_id is sent along with message data (e.g., in Mobile Push as ‘es_interaction_id’). This action allows you to report back to eSputnik when a message is delivered, opened, clicked, or fails to deliver, enabling accurate tracking and analytics.Input Parameters
Output
Update Mobile Push Message
Update Mobile Push Message
ESPUTNIK_UPDATE_MOBILEPUSH_MESSAGETool to update an existing mobile push notification message in eSputnik. Use when you need to modify a previously created push notification campaign. Updates message content including title, body text, images, action buttons, and custom data. Supports multilingual messages through the translations field. Requires the message ID and all required fields (name, title, text) must be provided even if not changing.Input Parameters
Output
Update Mobile Push Translation
Update Mobile Push Translation
ESPUTNIK_UPDATE_MOBILEPUSH_TRANSLATIONTool to update or add a language version for a mobile push message in eSputnik. Use when you need to create or modify translations for multilingual push notification campaigns. This action allows you to manage language-specific versions of a base mobile push message, enabling targeted communication with users in their preferred language. The translation can include localized title, text, images, buttons, and other notification settings.Input Parameters
Output
Update Preprocessor File By ID
Update Preprocessor File By ID
ESPUTNIK_UPDATE_PREPROCESSOR_FILE_BY_IDTool to update a preprocessor file’s data by providing a new external link. Use when you need to refresh or change the data source for an already uploaded preprocessor file. The file ID must be obtained from a previous Upload file for preprocessor operation. This method updates the file metadata including the external data link and time-to-live.Input Parameters
Output
Update SMS Message
Update SMS Message
ESPUTNIK_UPDATE_SMS_MESSAGETool to update an existing base SMS message template in eSputnik. Use when you need to modify the sender name, message text, or other properties of an existing SMS template. The SMS message must already exist with the provided ID. All three required fields (from, name, text) must be provided even if only updating some properties. The action supports multilingual messages through the languageCode parameter.Input Parameters
Output
Update SMS Translation
Update SMS Translation
ESPUTNIK_UPDATE_SMS_TRANSLATIONTool to update a language version of an SMS message in eSputnik. Use when you need to modify the content, sender name, or other properties of a specific language translation of an SMS message. This action updates an existing translation while keeping other language versions intact. The SMS message must already exist, and you’re updating the specified language version.Input Parameters
Output
Update Telegram Message
Update Telegram Message
ESPUTNIK_UPDATE_TELEGRAM_MESSAGEUpdate a base Telegram bot message in eSputnik. Use when you need to modify an existing message template’s content, buttons, or metadata. The message template is updated in eSputnik and can later be sent to contacts using the Send Message API. Only the fields provided in the request will be updated. Prerequisites: - Valid eSputnik API credentials with write permissions - Telegram bot configured in your eSputnik account - Valid message ID for an existing Telegram message Example usage: “Update Telegram message 4404257 with new text ‘Updated content‘“Input Parameters
Output
Update Telegram Translation
Update Telegram Translation
ESPUTNIK_UPDATE_TELEGRAM_TRANSLATIONUpdate a translated telegram bot message in eSputnik. Use when you need to modify an existing translation of a Telegram bot message. This action allows you to update the content, buttons, image, and metadata of a specific language version of a Telegram bot message. The message must already exist in eSputnik, and you must specify both the message ID and the language code to update.Input Parameters
Output
Upload Preprocessor File
Upload Preprocessor File
ESPUTNIK_UPLOAD_PREPROCESSOR_FILEUpload a preprocessor data file from an external URL with an optional TTL. The upload is asynchronous; a session ID may be returned for checking completion status.Input Parameters
Output
Upload Promotional Codes
Upload Promotional Codes
ESPUTNIK_UPLOAD_PROMOCODESTool to upload promotional codes to eSputnik in bulk. Use this action to create new promo codes or update existing ones. Existing promotional codes with the same string value will be updated with the new discount, expiration date, type, and usage status.