Удалить подписку профиля
Описание
Удалить подписку профиля.
Подписка останется в профиле, но получит метку: "is_delete" – true
.
URL-адрес
Метод: POST
https://example.com/api/v1.1/subscriptions/delete
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
profile_id | string | "abcdefghijklmnqrstuvwxyz" | Да | Идентификатор профиля |
resource_id | int | 1 | Да | Идентификатор ресурса |
db_id | int | 1 | Да | Идентификатор базы данных |
Дополнительно для Email-канала:
Параметры | Тип | Пример | Описание |
---|---|---|---|
channel | string | "email" | Тип канала |
string | "john@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* |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"db_id": 1,
"resource_id": 26,
"channel": "push",
"subscription_id": "abcdefghijklmnqrstuvwxyz",
"profile_id": "abcdefghijklmnqrstuvwxyz",
"provider": "Firefox"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<db_id>1</db_id>
<resource_id>26</resource_id>
<channel>push</channel>
<subscription_id>abcdefghijklmnqrstuvwxyz</subscription_id>
<profile_id>abcdefghijklmnqrstuvwxyz</profile_id>
<provider>Firefox</provider>
</xml>