post https://api.sendios.io/v1/push/
API-точка для надсилання системних / тригерних листів.
- Тригерні листи – це автоматичні листи, які відправляються користувачу у відповідь на якусь подію (тригер), пов’язану з цим користувачем.
- Cистемні листи – це автоматичні листи, які відправляються користувачу у відповідь на його дію. Більше інформації можна знайти у User Guide.
- Вказати тип листа, який необхідно відправити, треба через параметр категорії, зазначивши system або trigger відповідно.
- Це єдина API-точка, за допомогою якої можна створити користувача у системі за заданими
project_idтаemail. Користувач цей є унікальним для кожного Проєкту (project_id). - При створенні користувача за допомогою цієї точки, наведені у таблиці нижче поля зберігаються у системі та оновлюються при використанні цієї ж точки у майбутньому (у випадку, якщо дані змінюються):
| Параметр | Опис |
|---|---|
| namе | Ім'я користувача; |
| gender | Стать користувача; |
| platform_id | 0 – Unknown, 1 – Desktop, 2 – Mobile (Mobile Browser + Tablet), 3 – Android App, 4 – iOS App; |
| country | Двох- або трьохсимвольний код країни (наприклад "esp"); |
| language | Двосимвольний код мови (наприклад: "es"); |
| list_id | Ідентифікатор групи користувача; |
| client_user_id | Ідентифікатор користувача на стороні продукту; |
| ak | Auth key – ключ для авторизації / автологіну користувача на продукті; |
| age | Вік користувача; |
| photo | Посилання на фотографію користувача; |
| channel_id | Використовується для передачі каналу трафіку верхнього рівня, з якого користувач потрапив на продукт (наприклад, paid search); |
| subchannel_id | Використовується для передачі підканалу трафіку, з якого користувач потрапив на продукт (наприклад, facebook); |
| vip | Статус користувача: 1 – платник, 0 – не платник. |
- Якщо вам потрібно передати параметри, не зазначені у таблиці, це можна зробити за допомогою АРІ-точок Add and update user data by project id and email та Add and update user data by user_id.
- Змінні, які передаються через data-параметр, є динамічними та НЕ зберігаються у нас в системі, а лише використовуються у цьому конкретному листі.
- Перед надсиланням листів необхідно виконати налаштування, описані у Getting Started With Your API.
- Отримання відповіді 200 ОК означає, що ми отримали та взяли в опрацювання ваш запит, і що він пройшов валідацію. Дізнатися статус відправки листа можна в адмін-панелі у розділі User profile або за допомогою Webhooks.
- При відправці листа електронна адреса користувача проходить етап валідації.
Докладну інформацію щодо процесу валідації електронної адреси ви знайдете у відповідній статті Валідація електронної пошти.
За замовчуванням, VIP параметр має значення 0 (не платник). Інші параметри, які не були передані, залишаться незаповненими.