Описание

Добавить или редактировать подписку (изменить статус, подписать или отписать).

URL-адрес

Метод: POST

https://example.com/api/v1.1/subscriptions/set

Параметры запроса

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
formatstring"json"НетФормат возвращаемых данных
по умолчанию – "json"
db_idint1ДаИдентификатор базы данных
profile_idstring"abcdefghijklmnqrstuvwxyz"ДаИдентификатор профиля
resource_idint1ДаИдентификатор ресурса
statusstring"subscribed"Нет

Статус подписки.

Рекомендуется передавать только в тех случаях, когда необходимо обновить статус подписки.

priorityint
НетПриоритет подписки
datestring
НетДата регистрации
ipstring
НетIP регистрации
urlstring
НетURL регистрации
skip_triggersbooltrue
Пропустить запуск триггеров
по умолчанию – false

Дополнительно для Email-канала:

Параметры

Тип

Пример

Описание

channelstring"email"Тип канала
emailstring"john@example.com"Email-адрес

Дополнительно для PUSH-канала:

Параметры

Тип

Пример

Описание

channelstring"push"Тип канала
providerstring"Firefox"Тип провайдера
subscription_idstring"abcdefghijklmnqrstuvwxyz"Идентификатор подписки

Дополнительно для SMS-канала:

Параметры

Тип

Пример

Описание

channelstring"sms"Тип канала
phonestring"+79000000000"Номер телефона

Пример запроса

{
    "channel": "email",
    "db_id": 1,
    "email": "john@example.com",
    "priority": 10,
    "profile_id": "abcdefghijklmnqrstuvwxyz",
    "resource_id": 1,
    "status": "suspended",
    "token": "abcdefghijklmnqrstuvwxyz"
}

Пример ответа

{
    "data": {
        "action": "subscribed",
        "is_new_channel": false,
        "is_new_contact": false,
        "is_new_subscription": true,
        "is_restored": false,
        "is_safe": true
    },
    "error": 0,
    "error_text": "Successful operation"
}

Возвращаемые параметры

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
actionstringРезультат изменения подписки
is_safeboolОперация была безопасной (без hardbounce и т.д.)
is_new_subscriptionboolНе был подписан на этот ресурс ранее
is_new_channelboolУже подписан на этот ресурс, но на новый канал
is_new_contactboolНовый контакт уже подписан на ресурс или канал
is_restoredboolВосстановлена ранее удаленная подписка
  • No labels