Добавить или редактировать подписку
Описание
Добавить или редактировать подписку (изменить статус, подписать или отписать).
URL-адрес
Метод: POST
https://example.com/api/v1.1/subscriptions/set
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
db_id | int | 1 | Да | Идентификатор базы данных |
profile_id | string | "abcdefghijklmnqrstuvwxyz" | Да | Идентификатор профиля |
resource_id | int | 1 | Да | Идентификатор ресурса |
status | string | "subscribed" | Нет | Рекомендуется передавать только в тех случаях, когда необходимо обновить статус подписки. |
priority | int | Нет | Приоритет подписки | |
custom_fields | object |
| Нет | Стандартные и дополнительные поля подписки. Получить информацию о доступных полях подписки в ресурсе можно с помощью метода /v1.1/resources/fields_get |
cats | array |
| Нет | Категории ресурса, на которые подписать профиль |
date | string | 2018-08-22T00:00:00.000Z | Нет | Дата регистрации (в формате RFC3339) |
ip | string | 10.250.13.5 | Нет | IP регистрации |
url | string | https://example.com/ | Нет | URL регистрации |
skip_triggers | bool | true | Нет | Пропустить запуск триггеров (по умолчанию – false) |
Дополнительно для Email-канала:
Параметры | Тип | Пример | Описание |
---|---|---|---|
channel | string | "email" | Тип канала |
string | "example@example.com" | Email-адрес |
Дополнительно для PUSH-канала:
Параметры | Тип | Пример | Описание |
---|---|---|---|
channel | string | "push" | Тип канала |
provider | string | "Firefox" | Тип провайдера |
subscription_id | string | "abcdefghijklmnqrstuvwxyz" | Идентификатор подписки |
Дополнительно для SMS-канала:
Параметры | Тип | Пример | Описание |
---|---|---|---|
channel | string | "sms" | Тип канала |
phone | string | "+79000000000" | Номер телефона |
Дополнительно для Telegram-канала:
Параметры | Тип | Пример | Описание |
---|---|---|---|
channel | string | "telegram_bot" | Тип канала |
cc_data | object | { | id чата в Telegram-бот |
Дополнительно для WhatsApp*-канала:
Параметры | Тип | Пример | Описание |
---|---|---|---|
channel | string | "whatsapp" | Тип канала |
cc_data | object | { | Телефон профиля в WhatsApp* |