Підстановка промокоду з використанням API
Розглянемо, як передавати промокоди в тригерні листи за допомогою API-методів:
- Generate event (через сценарій),
- Send prepared message (без використання сценарію).
Метод Generate event
Метод Generate event служить для надсилання до eSputnik будь-яких кастомних подій, які можуть використовуватися для запуску сценарію.
Щоб підставити в тригерне повідомлення промокод за допомогою API, виконайте такі дії:
- Налаштуйте надсилання необхідних параметрів у події.
- Додайте змінну до повідомлення.
- Створіть сценарій.
1. Налаштування параметрів події
Подія повинна містити промокод та ідентифікатор контакту, який буде використаний для надсилання повідомлення (наприклад, email для надсилання листа або номер телефону для SMS).
Параметри події:
{ "params": [ { "name": "EmailAddress", "value": "mail@example.com", }, { "name": "code", "value": "ABC-123" } ] }
JSON
, де code — назва змінної, яка буде використовуватися в повідомленні, а ABC-123 — сам промокод, який отримає контакт.
2. Підстановка змінної в повідомлення
Додайте у повідомлення назву змінної, яка містить промокод, у форматі $!data.get('code'). Замість змінної контакт побачить промокод, переданий у події.
3. Створення сценарію
У параметрах повідомлення в сценарії вкажіть параметр з події, в якому міститься ідентифікатор контакту для надсилання повідомлення (у нашому прикладі це адреса електронної пошти, для інших каналів використовуйте відповідні ідентифікатори).
Докладніше про налаштування запуску сценарію за подією читайте в інструкції.
Метод Send prepared message
Метод Send prepared message використовується для надсилання підготовленого повідомлення одному або декільком контактам.
Ви можете надіслати унікальний промокод для кожного контакту.
Формат запиту:
{ "recipients": [{ "locator": "mail@example.com", "jsonParam": "{\"code\":\"ABC-123\"}" }], "email": true }
JSON
, де recipients — масив із одержувачами, у кожному елементі якого є параметр jsonParam. Його можна використовувати для передачі повідомлення будь-яких даних, в т. ч. промокода. Дані для повідомлення повинні бути в форматі JSON, перетвореному на рядок.
У запиті https://esputnik.com/api/v1/message/{id}/smartsend замість {id} потрібно використовувати ID повідомлення, яке має бути відправлене.
У повідомленні використовуйте змінну у форматі $!data.get('code').