Перейти к основному содержимому

Удалить подписку профиля

Описание

Удалить подписку профиля.

Подписка останется в профиле, но получит метку: "is_delete" – true.

URL-адрес

Метод: POST

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

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

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

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

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

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

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

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

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

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

ПараметрыТипПримерОписание
channelstring"telegram_bot"Тип канала
cc_dataobject
{
"id": 1
}
id чата в Telegram-бот

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

ПараметрыТипПримерОписание
channelstring"whatsapp"Тип канала
cc_dataobject
{
"phone": "+79000000000"
}
Телефон профиля в WhatsApp*

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

{
"token": "abcdefghijklmnqrstuvwxyz",
"db_id": 1,
"resource_id": 26,
"channel": "push",
"subscription_id": "abcdefghijklmnqrstuvwxyz",
"profile_id": "abcdefghijklmnqrstuvwxyz",
"provider": "Firefox"
}

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

{
"data": null,
"error": 0,
"error_text": "Successful operation"
}

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

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки

*Организация Meta, которой принадлежат продукты Instagram, Facebook и WhatsApp, признана экстремистской и запрещена на территории РФ.