The eSputnik connector lets your AI agent act in each user's eSputnik account. Each user connects their own eSputnik API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.
- Tools
- 59
- What they doRead · write · destructive
- 31 · 21 · 731 read21 write7 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the eSputnik connection
In AgentKit > Connections, create an eSputnik connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolesputnik_account_info_getGet account details.Read-onlyGet Account Info
Get account details. Returns the organization name, account email and settings. Use this to confirm the connection.
Inputs
This tool takes no inputs.
esputnik_additional_fields_listList contact additional field groups and fields.Read-onlyList Additional Fields
List contact additional field groups and fields. Returns fields with id, name and type. Use this to fill contact fields.
Inputs
This tool takes no inputs.
esputnik_address_books_listList address books (catalogs).Read-onlyList Address Books
List address books (catalogs). Returns address books with id, name and field groups. Use this to find the address book ID.
Inputs
This tool takes no inputs.
esputnik_balance_getGet the organization balance.Read-onlyGet Balance
Get the organization balance. Returns balance, currency and credit. Use this before large sends.
Inputs
This tool takes no inputs.
esputnik_balance_history_getGet the organization billing history for a date range.Read-onlyGet Billing History
Get the organization billing history for a date range. Returns charges and payments. Use this for spend reporting.
Inputs
date_fromstring- The initial date for the billing history. The date values are passed in the ISO_8061 format. Date format: YYYY-MM-DD. Defaults to Beginning of today. Example: 2026-01-01.
date_tostring- The end date for the billing history. The date values are passed in the ISO_8061 format. Date format: YYYY-MM-DD. Defaults to Now. Example: 2026-01-01.
esputnik_broadcast_getGet one broadcast.Read-onlyGet Broadcast
Get one broadcast. Returns its message, segments, schedule and status. Use this to check a campaign.
Inputs
broadcast_idstringrequired- Broadcast ID. Example: 6789012.
esputnik_broadcasts_listList broadcasts (campaign sends).Read-onlyList Broadcasts
List broadcasts (campaign sends). Returns broadcasts with id, name, message, segments, status and send date. Use esputnik_broadcast_get for one.
Inputs
maxrowsinteger- Maximum number of messages to return (maximum 500). Defaults to 10. Example: 1.
startindexinteger- Index of the first message to return from search results Numbering starts at 1. Defaults to 1. Example: 1.
esputnik_contact_getGet one contact by ID.Read-onlyGet Contact
Get one contact by ID. Returns the contact with names, channels, address, additional fields and segments. Use this when you know the ID.
Inputs
idintegerrequired- id. Example: 123456789.
esputnik_contact_messages_getGet the messages sent to one contact.Read-onlyGet Contact Message History
Get the messages sent to one contact. Returns messages with id, channel, subject, status and send time. Use this to see what a contact received.
Inputs
date_fromstringrequired- The initial date or date and time of the history period. The date/time values are passed in the ISO_8061 format. Date format: YYYY-MM-DD Date with time format: YYYY-MM-DDTHH:mm. Example: 2026-01-01.
date_tostringrequired- The final date or date amd time of the history period. The date/time values are passed in the ISO_8061 format. Date format: YYYY-MM-DD Date with time format: YYYY-MM-DDTHH:mm. Example: 2026-01-01.
channel_typesstring- Comma separated list of user messages channel types that will be included to the response. Example: email,sms.
contact_idinteger- Contact ID number (either contactId, or externalCustomerId, or email, or phone number must be specified). Example: 1.
emailstring- Contact's email address (either contactId, or externalCustomerId, or email, or phone number must be specified). Example: jane@example.com.
external_customer_idstring- External Customer ID (either contactId, or externalCustomerId, or email, or phone number must be specified). Example: CUST-1001.
maxrowsinteger- Max number of items in the response. Default value is 10. Maximum value is 100. Example: 1.
offsetinteger- Offset from the first item. For pagination purposes. Defaults to 0. Example: 0.
phonestring- Contact's phone number (either contactId, or externalCustomerId, or email, or phone number must be specified). Example: 380501234567.
esputnik_contact_subscriptions_getGet the subscription categories a contact is subscribed to.Read-onlyGet Contact Subscriptions
Get the subscription categories a contact is subscribed to. Returns the list of subscription keys. Use this before esputnik_contact_subscriptions_update.
Inputs
idintegerrequired- Contact ID. Example: 123456789.
esputnik_contacts_activity_getGet message activity (delivered, opened, clicked, unsubscribed...) of contacts over a date range.Read-onlyGet Contacts Activity
Get message activity (delivered, opened, clicked, unsubscribed...) of contacts over a date range. Returns activity rows with contact, channel, status and timestamps. Use this for engagement reporting.
Inputs
date_fromstringrequired- Initial date and time of the period you want to get the contact activity for. Example: 2026-01-01.
date_tostringrequired- Final date and time of the period you want to get the contact activity for. Example: 2026-01-01.
activity_statusstring- Activity status (DELIVERED, UNDELIVERED, READ, UNSUBSCRIBED, CLICKED, SPAM). One of: DELIVERED, UNDELIVERED, READ, UNSUBSCRIBED, CLICKED, SPAM. Example: DELIVERED.one of
DELIVEREDUNDELIVEREDREADUNSUBSCRIBEDCLICKEDSPAM emailstring- Email address. Example: jane@example.com.
maxrowsinteger- Max number of activity entries in response. Defaults to 25000. Example: 1.
message_tagstring- Message tag. Example: promo.
mob_push_tokenstring- Mob Push token. Example: apns-token-123.
offsetstring- Last found contact activity offset in previous search results. It is used to continue search. Example: 0.
smsstring- Contact's phone number. Example: 380501234567.
telegram_tokenstring- Telegram token. Example: tg-123456.
web_push_tokenstring- Web Push token. Example: fcm-token-123.
esputnik_contacts_import_status_getGet the status of a bulk contact import.Read-onlyGet Contact Import Status
Get the status of a bulk contact import. Returns status and counts of processed and failed contacts. Use this after esputnik_contacts_upsert.
Inputs
session_idstringrequired- Async session identifier. Example: 8f2c1a3e-5b7d-4e9f-a1c2-3d4e5f6a7b8c.
esputnik_contacts_searchSearch contacts by email, phone, name or external ID, or list them page by page.Read-onlySearch Contacts
Search contacts by email, phone, name or external ID, or list them page by page. Returns contacts with id, firstName, lastName, channels, fields, groups and addressBookId. Use this to find a contact. Use esputnik_contact_get for one by ID.
Inputs
emailstring- Contact's email address. Example: jane@example.com.
external_customer_idstring- External contact ID. Example: CUST-1001.
firstnamestring- Contact first name. Example: Jane.
lastnamestring- Contact last name. Example: Doe.
maxrowsinteger- Maximum number of returned contacts (max 500). Defaults to 500. Example: 1.
smsstring- Contact's phone number. Example: 380501234567.
sort_bystring- Possible value is 'contactId'. Only actual for searches without conditions. By default, the date of contact update is used for the search. If this parameter is used, sorting is done by contactId. Using this parameter allows you to upload contacts faster. Example: contactId.
startindexinteger- The number of the first contact returned in the search results. Numbering starts at 1. Defaults to 1. Example: 1.
esputnik_email_interfaces_listList the email sender addresses configured for the organization.Read-onlyList Email Senders
List the email sender addresses configured for the organization. Returns sender emails and names. Use this for the from field of esputnik_email_send.
Inputs
This tool takes no inputs.
esputnik_email_message_getGet one saved email message template.Read-onlyGet Email Message
Get one saved email message template. Returns the template's content and settings. Use this to read a template.
Inputs
idintegerrequired- Email message id. Example: 123456789.
esputnik_email_message_view_link_getGet a web link that shows an email template.Read-onlyGet Email View Link
Get a web link that shows an email template. Returns the view URL. Use this to preview a template.
Inputs
idstringrequired- Message ID. Example: 123456789.
esputnik_email_messages_searchSearch saved email message templates by name or tag.Read-onlySearch Email Messages
Search saved email message templates by name or tag. Returns messages with id, name, tags and (for email) subject. Use this to find a template ID.
Inputs
maxrowsinteger- Maximum number of messages to return (max. 500). Defaults to 500. Example: 1.
searchstring- Search condition (a part of the message name or a tag). Defaults to. Example: welcome.
startindexinteger- The index of the first message to return from the search result. Numbering starts at 1. Defaults to 1. Example: 1.
esputnik_message_status_getGet the delivery status of sent messages by request IDs.Read-onlyGet Message Status
Get the delivery status of sent messages by request IDs. Returns status (e.g. DELIVERED, OPENED, CLICKED, FAILED) per request ID. Use this after a send tool.
Inputs
idsstring- ID of sent message. This field is present if message was successfully queued for sending. Example: c2b4f2a1-1111-2222-3333-444455556666.
esputnik_mobilepush_message_getGet one saved mobile push message template.Read-onlyGet Mobile Push Message
Get one saved mobile push message template. Returns the template's content and settings. Use this to read a template.
Inputs
idintegerrequired- Mobile push message id. Example: 123456789.
esputnik_mobilepush_messages_searchSearch saved mobile push message templates by name or tag.Read-onlySearch Mobile Push Messages
Search saved mobile push message templates by name or tag. Returns messages with id, name, tags and (for email) subject. Use this to find a template ID.
Inputs
maxrowsinteger- Maximum number of messages to return (not more than 500). Defaults to 500. Example: 1.
searchstring- Search condition (part of the message name or a tag). Example: welcome.
startindexinteger- Index of the first returned message from the search results. Numbering starts at 1. Defaults to 1. Example: 1.
esputnik_promocodes_countCount available promotional codes.Read-onlyCount Promo Codes
Count available promotional codes. Returns the number of available codes. Use this to check the pool.
Inputs
active_due_daysinteger- The number of days left for the promo codes to remain active (activeDueDays=7 means the promo code remains active during the next 7 days, starting from tomorrow). Example: 1.
discountinteger- Promo code discount amount. Example: 1.
typestring- Promo code type. Example: PERCENT.
esputnik_promocodes_getGet promotional codes, optionally reserving them for use.Read-onlyGet Promo Codes
Get promotional codes, optionally reserving them for use. Returns promo codes with type, discount and expiration. Use this to hand out codes.
Inputs
active_due_daysinteger- The days left for promo codes to remain active (activeDueDays=7 means: the promo code remains active for the following 7 days, starting from tomorrow). Example: 1.
discountinteger- Discount received with the promo code. Example: 1.
in_useboolean- When 'true', the promo code has been used, when 'false', the promo code has not been used. Example: true.
typestring- Promo code type. Example: PERCENT.
esputnik_segment_contacts_listList contacts in a segment.Read-onlyList Segment Contacts
List contacts in a segment. Returns contacts with id, channels and fields. Use this to read a segment's members.
Inputs
idintegerrequired- Segment ID. Example: 123456789.
ascboolean- Sort in ascending (ASC) or descending (DESC) order. Defaults to true. Example: true.
maxrowsinteger- Maximum number of contacts to return (max. 500). Defaults to 500. Example: 1.
order_by_tsboolean- Order by the time of addition to the segment. Defaults to false. Example: true.
startindexinteger- The index of the first contact returned from the search result. Numbering starts at 1. Defaults to 1. Example: 1.
esputnik_segments_listList contact segments (groups).Read-onlyList Segments
List contact segments (groups). Returns segments with id, name and type (static or dynamic). Use this for segment IDs.
Inputs
maxrowsinteger- Maximum number of segments to be returned (max. 500). Defaults to 500. Example: 1.
namestring- name. Example: sk-test welcome.
startindexinteger- The index of the first segment returned from the search result. Numbering starts at 1. Defaults to 1. Example: 1.
esputnik_sms_interfaces_listList the SMS sender names (alpha names).Read-onlyList SMS Senders
List the SMS sender names (alpha names). Returns sender names. Use this for esputnik_sms_send.
Inputs
This tool takes no inputs.
esputnik_sms_message_getGet one saved SMS message template.Read-onlyGet SMS Message
Get one saved SMS message template. Returns the template's content and settings. Use this to read a template.
Inputs
idintegerrequired- SMS message ID. Example: 123456789.
esputnik_sms_messages_searchSearch saved SMS message templates by name or tag.Read-onlySearch SMS Messages
Search saved SMS message templates by name or tag. Returns messages with id, name, tags and (for email) subject. Use this to find a template ID.
Inputs
maxrowsinteger- maxrows. Defaults to 500. Example: 1.
searchstring- Search condition (a part of the message name or a tag). Example: welcome.
startindexinteger- startindex. Defaults to 1. Example: 1.
esputnik_subscriptions_listList the organization's subscription categories.Read-onlyList Subscription Categories
List the organization's subscription categories. Returns subscription keys and names. Use this for esputnik_contact_subscriptions_update.
Inputs
This tool takes no inputs.
esputnik_viber_message_getGet one saved Viber message template.Read-onlyGet Viber Message
Get one saved Viber message template. Returns the template's content and settings. Use this to read a template.
Inputs
idintegerrequired- Viber message ID. Example: 123456789.
esputnik_viber_messages_searchSearch saved Viber message templates by name or tag.Read-onlySearch Viber Messages
Search saved Viber message templates by name or tag. Returns messages with id, name, tags and (for email) subject. Use this to find a template ID.
Inputs
maxrowsinteger- Maximum number of messages to return (not more than 500). Defaults to 500. Example: 1.
searchstring- Search condition (part of the message name or a tag). Example: welcome.
startindexinteger- Index of the first returned message from the search results. Numbering starts at 1. Defaults to 1. Example: 1.
esputnik_workflows_listList automation workflows.Read-onlyList Workflows
List automation workflows. Returns workflows with id, name and status. Use this to see automations.
Inputs
maxrowsinteger- Maximum number of workflows to be returned (max. 500). Defaults to 500. Example: 1.
namestring- name. Example: sk-test welcome.
startindexinteger- The index of the first workflow returned from the search result. Numbering starts at 1. Defaults to 1. Example: 1.
esputnik_broadcast_createCreate a broadcast that sends a saved message to segments now or at a scheduled time.WriteCreate Broadcast
Create a broadcast that sends a saved message to segments now or at a scheduled time. Returns the broadcast id. Use this to send a campaign. Use esputnik_broadcast_cancel to cancel a scheduled one.
Inputs
groupsarrayrequired- groups. Example: [201234567]
message_idstringrequired- Message ID. Example: AB2489300.
app_idstring- Application ID. For mob push and telegram messages. Example: 8182a34b-9c87-4777-8de1-598f2df9de4f.
batch_interval_unitstring- The broadcasting speed management parameter—the time interval. One of: MINUTE, HOUR, DAY, MONTH. Example: MINUTE.one of
MINUTEHOURDAYMONTH batch_sizeinteger- The broadcasting speed management parameter, the number of messages per specified time interval. Example: 50.
domainstring- Broadcast domain. For web push messages. Example: SportsNewsUpdates.
excluded_groupsarray- excluded groups. Example: [201234568]
start_datestring- The broadcast start date. Use the following format: "YYYY-MM-DDTHH:mm". If not specified, the broadcast starts immediately. Example: 2023-10-28T14:00.
titlestring- Broadcast title. Example: Season's discounts.
esputnik_contact_subscribeSubscribe a contact (adds or updates it and triggers the subscription workflow, e.g.WriteSubscribe Contact
Subscribe a contact (adds or updates it and triggers the subscription workflow, e.g. double opt-in). Returns the contact id. Use this for sign-up forms. Use esputnik_contact_upsert to save without the subscription event.
Inputs
contactobjectrequired- Contact for subscription. Example: {"firstName": "Jane", "lastName": "Doe", "channels": [{"type": "email", "value": "jane@example.com"}]}
form_typestring- The subscription form name. It allows you to use several independent subscription forms. All characters are acceptable, except: < ; ’ \ / | " ' ^ ? ! , >. Example: Newsletter subscription.
groupsarray- The list of segment names where a new/updated contact will be added. Example: ["sk-test VIP"]
subscriptionsarray- Subscription categories added for a contact. Example: ["newsletter", "promotions"]
esputnik_contact_subscriptions_updateReplace a contact's subscription categories.WriteUpdate Contact Subscriptions
Replace a contact's subscription categories. Returns an empty response on success. Use this to manage preferences.
- Idempotent
Inputs
idintegerrequired- Contact ID. Example: 123456789.
subscriptionsarrayrequired- Subscription category keys. Example: ["newsletter", "promotions"]
esputnik_contact_updateUpdate a contact by ID.WriteUpdate Contact
Update a contact by ID. Returns an empty response on success. Use this to change a contact's fields.
- Idempotent
Inputs
idintegerrequired- Contact ID. Example: 123456789.
addressobject- Contact's full address. Example: {"region": "Kyiv", "town": "Kyiv", "address": "1 Khreshchatyk St", "postcode": "01001"}
address_book_idinteger- Catalog ID. You can get the value using the /v1/addressbooks GET method. Optional parameter. Example: 1.
channelsarray- You can add maximum two channels of the same type. It is necessary to specify at least one channel. Example: [{"type": "email", "value": "jane@example.com"}, {"type": "sms", "value": "380501234567"}]
contact_keystring- contact key. Example: jane@example.com.
external_customer_idstring- external customer id. Example: CUST-1001.
fieldsarray- Values of the additional fields of a contact. Example: [{"id": 12345, "value": "Gold"}]
first_namestring- Contact's first name. Example: John.
id_bodyinteger- Contact ID. Example: 123456789.
language_codestring- Language code. Optional parameter. Example: en.
last_namestring- Contact's last name. Example: Smith.
market_idstring- Market ID. Optional parameter. Up to 64 characters. Allowed: [a–zA-Z0–9-_]. Example: ua-main.
time_zonestring- Time zone. Optional parameter. See TZ database name. Example: Europe/Kyiv.
esputnik_contact_upsertAdd a contact or update the existing one with the same email, phone or external ID.WriteAdd or Update Contact
Add a contact or update the existing one with the same email, phone or external ID. Returns the contact id. Use this to save one contact. Use esputnik_contact_subscribe to subscribe with double opt-in.
Inputs
addressobject- Contact's full address. Example: {"region": "Kyiv", "town": "Kyiv", "address": "1 Khreshchatyk St", "postcode": "01001"}
address_book_idinteger- You can get the info about catalogs using the /v1/addressbooks GET method. Example: 7200.
channelsarray- The list of media channels. Example: [{"type": "email", "value": "jane@example.com"}, {"type": "sms", "value": "380501234567"}]
contact_keystring- Contact's key. Example: jane@example.com.
external_customer_idstring- External contact id. Example: CUST-1001.
fieldsarray- Values of the additional fields for a contact. Example: [{"id": 12345, "value": "Gold"}]
first_namestring- Contact’s first name. The following rules apply to character usage: - Max length: 40 symbols. - Letters from any alphabet are allowed (Unicode characters). - Three words longer than 3 characters and three words with a maximum of 3 characters are allowed. - Up to 3 digits are allowed. - Special characters are not allowed, except for: -- Apostrophes ''ʼ´ʹʻʽʾʿˈˊˮʹ΄՚᾽᾿'‛′‵Ꞌꞌ' (only inside words) -- Hyphen - (only inside words) -- One dot at the end of words having max 3 characters. Example: Jr. - Names consisting only of numbers and special characters are not allowed.
groupsarray- The list of the static segments where the contact is present. Used only when receiving contacts. Example: [{"name": "sk-test VIP"}]
idinteger- Contact ID. Example: 123456789.
language_codestring- Language code for the contact. Example: en.
last_namestring- Contact’s last name. The following rules apply to character usage: - Max length: 40 symbols. - Letters from any alphabet are allowed (Unicode characters). - Three words longer than 3 characters and three words with a maximum of 3 characters are allowed. - Up to 3 digits are allowed. - Special characters are not allowed, except for: -- Apostrophes ''ʼ´ʹʻʽʾʿˈˊˮʹ΄՚᾽᾿'‛′‵Ꞌꞌ' (only inside words) -- Hyphen - (only inside words) -- One dot at the end of words having max 3 characters. Example: Jr. - Names consisting only of numbers and special characters are not allowed.
market_idstring- Market ID. Optional parameter. Up to 64 characters. Allowed: [a–zA-Z0–9-_]. Example: ua-main.
time_zonestring- The contact's time zone. See TZ database name. Example: Europe/Kyiv.
esputnik_contacts_upsertAdd or update up to 3000 contacts in one request, deduplicating by a chosen key, and optionally add them to segments.WriteAdd or Update Contacts
Add or update up to 3000 contacts in one request, deduplicating by a chosen key, and optionally add them to segments. Returns asyncSessionId to check with esputnik_contacts_import_status_get. Use this for bulk sync. Use esputnik_contact_upsert for one contact.
Inputs
contactsarrayrequired- The list of contacts that will be added or updated (max. 3000). If this array of objects contains externalCustomerId, the search uses externalCustomerId and ignores dedupeOn. Example: [{"firstName": "Jane", "lastName": "Doe", "channels": [{"type": "email", "value": "jane@example.com"}], "externalCustomerId": "CUST-1001"}]
dedupe_onstringrequired- The field for determining the contact uniqueness. Important the field set as dedupeOn will not be updated. One of: email, sms, push, email_or_sms, id, externalCustomerId, fieldId. Example: email.one of
emailsmspushemail_or_smsidexternalCustomerIdfieldId contact_fieldsarray- The list of contacts’ fields to be updated. All the contact fields will be updated if this parameter is not specified. The fields will be updated with the ‘null’ value if no data for updating is transmitted. Example: ["firstName", "lastName", "email"]
custom_fields_idsarray- The list of the custom field IDs to be updated. The custom fields are updated if their IDs are in this list. This field is required when a contact is updated. Example: [12345]
event_key_for_new_contactsstring- The event type identification key. An event of corresponding type is generated for each contact. If the system does not have an event type with such a key, a new event type is created. All characters are allowed, except < ; ’ \ / | " ' ^ ? ! , > Max length: 100 symbols. Example: contactImported.
field_idinteger- The field for determining the contact uniqueness. This field is taken into account when dedupeOnProperty has the fieldId value. Example: 1.
group_namesarray- The list of the segment names where the new/updated contacts will be added to. Example: ["sk-test VIP"]
group_names_excludearray- The list of the segment names where the new/updated contacts will be excluded from. Example: ["Inactive"]
restore_deletedboolean- Choose either to restore the previously deleted contacts or not. Example: true.
esputnik_email_message_createCreate a email message template.WriteCreate Email Message
Create a email message template. Returns the created message with its id. Use this to add a reusable template.
Inputs
fromstringrequired- Required parameter. Sender name and email address, e.g. "from": "\"name\" <info@test.com>". Example: "Acme Store" <info@example.com>.
html_textstringrequired- Message HTML code. Example: <html><body><p>Welcome, $!data.get('firstName')!</p></body></html>.
namestringrequired- Message name. Example: sk-test welcome.
subjectstringrequired- Message subject. Example: Thanks for signing up.
amp_htmlstring- Message AMP code. Example: <!doctype html><html amp4email><head></head><body>Hi</body></html>.
cssstring- Message styles. Example: p { color: #333; }
idinteger- Message ID. Example: 123456789.
language_codestring- Language code. Example: en.
languagesarray- An array with the language codes for multilingual messages. Available for the GET method only. Example: ["en"]
raw_htmlstring- Message HTML code without styles. Example: <p>Welcome to Acme!</p>.
subscriptions_keysarray- Subscription categories keys, assigned to a message. Example: ["newsletter"]
tagsarray- List of tags. Example: ["welcome", "sk-test"]
templateboolean- template. Example: true.
translationsarray- The array of the language versions for the current message. Available for the GET method only. Example: [{"languageCode": "uk", "subject": "Ласкаво просимо"}]
updated_datestring- Message updated date. Example: 2026-01-01T00:00:00Z.
esputnik_email_message_updateUpdate a email message template.WriteUpdate Email Message
Update a email message template. Returns an empty response on success. Use this to change a template.
- Idempotent
Inputs
fromstringrequired- Required parameter. Sender name and email address, e.g. "from": "\"name\" <info@test.com>". Example: "Acme Store" <info@example.com>.
html_textstringrequired- Message HTML code. Example: <html><body><p>Welcome, $!data.get('firstName')!</p></body></html>.
idintegerrequired- Email message id. Example: 123456789.
namestringrequired- Message name. Example: sk-test welcome.
subjectstringrequired- Message subject. Example: Thanks for signing up.
amp_htmlstring- Message AMP code. Example: <!doctype html><html amp4email><head></head><body>Hi</body></html>.
cssstring- Message styles. Example: p { color: #333; }
id_bodyinteger- Message ID. Example: 123456789.
language_codestring- Language code. Example: en.
languagesarray- An array with the language codes for multilingual messages. Available for the GET method only. Example: ["en"]
raw_htmlstring- Message HTML code without styles. Example: <p>Welcome to Acme!</p>.
subscriptions_keysarray- Subscription categories keys, assigned to a message. Example: ["newsletter"]
tagsarray- List of tags. Example: ["welcome", "sk-test"]
templateboolean- template. Example: true.
translationsarray- The array of the language versions for the current message. Available for the GET method only. Example: [{"languageCode": "uk", "subject": "Ласкаво просимо"}]
updated_datestring- Message updated date. Example: 2026-01-01T00:00:00Z.
esputnik_email_sendSend a one-off email (your own HTML and subject) to one or more addresses.WriteSend Email
Send a one-off email (your own HTML and subject) to one or more addresses. Returns results with a requestId per recipient for esputnik_message_status_get. Use this for transactional emails you compose. Use esputnik_message_send_prepared for a saved template.
Inputs
emailsarrayrequired- The list of recipients. Example: ["jane@example.com"]
fromstringrequired- Sender address (enter one of the valid sender addresses). Address format: "\"name\" <test@mail.com>". Example: "Acme Store" <info@example.com>.
html_textstringrequired- Message HTML code. Example: <html><body><p>Welcome, $!data.get('firstName')!</p></body></html>.
subjectstringrequired- Message subject. Example: Seasonal sale.
amp_html_textstring- Message AMP HTML code. Example: <!doctype html><html amp4email><head></head><body>Hi</body></html>.
external_request_idstring- External request ID. It is the same for all the recipients. Example: order-1001-confirmation.
plain_textstring- Version of the message in plain text. Example: Explore our new collection.
skip_personalisationboolean- Skip the application of personalization to the message. Example: true.
subscriptions_keysarray- Array of subscription category keys added to the message. Example: ["newsletter"]
tagsarray- The list of tags assigned to the message. Example: ["welcome", "sk-test"]
track_urlsboolean- The parameter determines whether to track links in the message or not. The default value is ‘true’. Example: true.
esputnik_event_generateSend a custom event (e.g.WriteGenerate Event
Send a custom event (e.g. a cart abandonment or a password reset) for a contact to trigger workflows. Returns an empty response on success. Use this to trigger automations.
Inputs
event_type_keystringrequired- Unique identifier for the event type, e.g., PageViewed. Example: EventName.
paramsobject- An objects — key-value pairs containing contact identifiers (required) and event-specific parameters (optional). Example: {"email": "jane@example.com", "cartTotal": "49.90"}
esputnik_message_send_preparedSend a saved message template (email, SMS, Viber, push...) to recipients, filling template parameters per recipient.WriteSend Prepared Message
Send a saved message template (email, SMS, Viber, push...) to recipients, filling template parameters per recipient. Returns results with a requestId per recipient. Use this to send a template from esputnik_email_messages_search or similar.
Inputs
idintegerrequired- Message ID. Example: 123456789.
recipientsarrayrequired- recipients. Example: [{"locator": "jane@example.com", "jsonParam": "{\"orderNumber\": \"1001\"}"}]
emailboolean- Message type. true for email, false for other media-channels. Example: true.
from_namestring- Sender name. For email, indicate the sender name only, without an email address. The sender's email address selected in the message is used. For SMS, use the alphanumeric sender ID. If the parameter is not indicated, the sender name selected in the message is used. Example: Acme Store.
esputnik_orders_addAdd or update orders (with items, status and totals) for revenue reporting and order-based workflows.WriteAdd Orders
Add or update orders (with items, status and totals) for revenue reporting and order-based workflows. Returns results per order. Use this to sync orders from your store.
Inputs
ordersarray- orders. Example: [{"externalOrderId": "1001", "externalCustomerId": "CUST-1001", "totalCost": 49.9, "status": "INITIALIZED", "date": "2026-01-15T10:00:00", "currency": "EUR",...
esputnik_products_upsertAdd or update products in the product feed.WriteAdd or Update Products
Add or update products in the product feed. Returns results per product. Use this to sync the catalog used in recommendations.
Inputs
language_codestring- Default language for top-level product fields. Example: en.
productsarray- Products to create or update. Example: [{"id": "SKU-123"}]
esputnik_segment_contacts_attachAdd contacts to a static segment.WriteAdd Contacts to Segment
Add contacts to a static segment. Returns an empty response on success. Use esputnik_segment_contacts_detach to remove them.
Inputs
idintegerrequired- id. Example: 123456789.
contact_idsarray- The list of attach/detach contact ids to static group (max. 500). Example: [123456789, 123456790]
external_customer_idsarray- The list of attach/detach external contacts ids to static group (max. 500). Example: ["CUST-1001", "CUST-1002"]
esputnik_segment_contacts_detachRemove contacts from a static segment.WriteRemove Contacts from Segment
Remove contacts from a static segment. Returns an empty response on success. Use this to clean up a segment.
Inputs
idintegerrequired- Segment ID. Example: 123456789.
contact_idsarray- The list of attach/detach contact ids to static group (max. 500). Example: [123456789, 123456790]
external_customer_idsarray- The list of attach/detach external contacts ids to static group (max. 500). Example: ["CUST-1001", "CUST-1002"]
esputnik_sms_message_createCreate a SMS message template.WriteCreate SMS Message
Create a SMS message template. Returns the created message with its id. Use this to add a reusable template.
Inputs
fromstringrequired- Sender name. Example: "Acme Store" <info@example.com>.
namestringrequired- Message name. Example: sk-test welcome.
textstringrequired- Message text. Example: Your order 1001 has shipped.
idinteger- Message ID. Example: 123456789.
language_codestring- Language code. Example: en.
languagesarray- An array with the language codes for multilingual messages. Available for the GET method only. Example: ["en"]
subscriptions_keysarray- Subscription categories keys, assigned to a message. Example: ["newsletter"]
tagsarray- List of tags. Example: ["welcome", "sk-test"]
track_urlsboolean- The parameter determines whether to track links in a message or not. The default value is ‘false’. Example: true.
translationsarray- An array with translations to other languages. Available for the GET method only. Example: [{"languageCode": "uk", "subject": "Ласкаво просимо"}]
esputnik_sms_message_updateUpdate a SMS message template.WriteUpdate SMS Message
Update a SMS message template. Returns an empty response on success. Use this to change a template.
- Idempotent
Inputs
fromstringrequired- Sender name. Example: "Acme Store" <info@example.com>.
idintegerrequired- Sms message ID. Example: 123456789.
namestringrequired- Message name. Example: sk-test welcome.
textstringrequired- Message text. Example: Your order 1001 has shipped.
id_bodyinteger- Message ID. Example: 123456789.
language_codestring- Language code. Example: en.
languagesarray- An array with the language codes for multilingual messages. Available for the GET method only. Example: ["en"]
subscriptions_keysarray- Subscription categories keys, assigned to a message. Example: ["newsletter"]
tagsarray- List of tags. Example: ["welcome", "sk-test"]
track_urlsboolean- The parameter determines whether to track links in a message or not. The default value is ‘false’. Example: true.
translationsarray- An array with translations to other languages. Available for the GET method only. Example: [{"languageCode": "uk", "subject": "Ласкаво просимо"}]
esputnik_sms_sendSend an SMS with your own text to one or more phone numbers from an SMS sender (alpha name).WriteSend SMS
Send an SMS with your own text to one or more phone numbers from an SMS sender (alpha name). Returns results with a requestId per recipient. Use this for one-off SMS. Use esputnik_sms_interfaces_list for sender names.
Inputs
fromstringrequired- Sender name. Enter one of the valid sender names. Example: "Acme Store" <info@example.com>.
textstringrequired- Message text. Example: Your order 1001 has shipped.
external_request_idstring- External request ID. It is the same for all the recipients. Example: order-1001-confirmation.
group_idinteger- Required parameter, if "phoneNumbers" is not specified. Segment ID to which the message will be sent. Example: 201234567.
phone_numbersarray- Required parameter, if "groupId" is not specified. Example: ["380501234567"]
subscriptions_keysarray- subscriptions keys. Example: ["newsletter"]
tagsarray- The list of tags to be assigned to a message. Example: ["welcome", "sk-test"]
track_urlsboolean- The parameter determines whether to track links in a message or not. The default value is ‘false’. Example: true.
esputnik_unsubscribed_addAdd email addresses to the unsubscribed list.WriteAdd Emails to Unsubscribed
Add email addresses to the unsubscribed list. Returns an empty response on success. Use this to honor opt-outs.
Inputs
emailsarrayrequired- emails. Example: ["jane@example.com"]
esputnik_unsubscribed_removeRemove email addresses from the unsubscribed list.WriteRemove Emails from Unsubscribed
Remove email addresses from the unsubscribed list. Returns an empty response on success. Use this only with the contact's consent.
Inputs
emailsarrayrequired- emails. Example: ["jane@example.com"]
esputnik_viber_sendSend a Viber message with your own text to one or more phone numbers.WriteSend Viber Message
Send a Viber message with your own text to one or more phone numbers. Returns results with a requestId per recipient. Use this for one-off Viber messages.
Inputs
textstringrequired- Message text. Example: Your order 1001 has shipped.
actionstring- A clickable link embedded in a picture or in a button. Example: https://example.com/.
captionstring- caption. Example: Shop now.
carousel_itemsarray- Carousel items (2-5 items). When provided, img/action/caption are used only for SMS fallback. Example: [{"title": "Sneakers", "image": "https://example.com/1.png", "action": "https://example.com/p/1"}]
external_request_idstring- External request ID. It is the same for all the recipients. Example: order-1001-confirmation.
fromstring- Sender's name. Required parameter if more than one sender is available. Example: "Acme Store" <info@example.com>.
group_idinteger- Required parameter . If "phoneNumbers" are not specified. Example: 2345678.
imgstring- img. Example: https://example.com/promo.png.
phone_numbersarray- The list of the recipient phone numbers. Required parameter , if "groupId" is not specified. Example: ["380501234567"]
subscriptions_keysarray- subscriptions keys. Example: ["newsletter"]
tagsarray- The list of tags to be assigned to a message. Example: ["welcome", "sk-test"]
template_idstring- Provider template ID for a transactional Viber message. Example: viber-tpl-001.
track_urlsboolean- The parameter determines whether to track links in a message or not. The default value is ‘true’. Example: true.
transactionalboolean- Whether the message is transactional. Defaults to false. Example: true.
ttl_secondsinteger- Message lifetime in seconds, the default value is day. Example: 36000.
esputnik_broadcast_cancelCancel a scheduled broadcast.DestructiveCancel Broadcast
Cancel a scheduled broadcast. Returns an empty response on success. Use this before the scheduled send time.
- Idempotent
Inputs
broadcast_idstringrequired- Broadcast ID. Example: 6789012.
esputnik_contact_deleteDelete a contact by ID, optionally erasing all its data (GDPR).DestructiveDelete Contact
Delete a contact by ID, optionally erasing all its data (GDPR). Returns an empty response on success. Use esputnik_contact_delete_by_external_id when you only have your own customer ID.
- Idempotent
Inputs
idintegerrequired- Contact ID. Example: 123456789.
eraseboolean- Permanent deletion of all contact's data: contact profile attributes, contact activity, web- and mobile tracking. It is not possible to recover the deleted data. Defaults to false. Example: true.
esputnik_contact_delete_by_external_idDelete a contact by your external customer ID.DestructiveDelete Contact by External ID
Delete a contact by your external customer ID. Returns an empty response on success. Use this when you only have your own customer ID.
- Idempotent
Inputs
eraseboolean- Permanent deletion of all contact data: contact profile attributes, contact activity, web- and mobile tracking. It is not possible to recover deleted data. Defaults to false. Example: true.
external_customer_idstring- external customer id. Example: CUST-1001.
esputnik_email_message_deleteDelete a email message template.DestructiveDelete Email Message
Delete a email message template. Returns an empty response on success. Use this to remove a template.
- Idempotent
Inputs
idintegerrequired- Email message id. Example: 123456789.
esputnik_orders_deleteDelete orders by external order IDs.DestructiveDelete Orders
Delete orders by external order IDs. Returns an empty response on success. Use this to remove test orders.
- Idempotent
Inputs
external_order_idstring- ID of an order in the external system. Example: 1001.
fromstring- Start date (inclusively). Example: "Acme Store" <info@example.com>.
tostring- End date (inclusively). Example: 2026-01-31.
esputnik_products_deleteDelete products from the product feed.DestructiveDelete Products
Delete products from the product feed. Returns an empty response on success. Use this to remove products.
- Idempotent
Inputs
productsarray- Products to delete. Example: [{"id": "SKU-123"}]
site_idstring- Client site/account identifier. Example: my_store.
esputnik_sms_message_deleteDelete a SMS message template.DestructiveDelete SMS Message
Delete a SMS message template. Returns an empty response on success. Use this to remove a template.
- Idempotent
Inputs
idintegerrequired- Sms message ID. Example: 123456789.
No tools match.