Описание
Удалить подписку профиля.
Подписка останется в профиле, но получит метку: "is_delete" – true.
URL-адрес
Метод: POST
https://example.com/api/v1.1/subscriptions/delete
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| format | string | "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": 1
}
| id чата в Telegram-бот |
Дополнительно для WhatsApp-канала:
Параметры | Тип | Пример | Описание |
|---|---|---|---|
| channel | string | "whatsapp" | Тип канала |
| cc_data | object | {
"phone": "+79000000000"
}
| Телефон профиля в WhatsApp |
Пример запроса
{
"channel": "email",
"db_id": 1,
"email": "john@example.com",
"profile_id": "abcdefghijklmnqrstuvwxyz",
"resource_id": 1,
"token": "abcdefghijklmnqrstuvwxyz"
}
Пример ответа
{
"error": 0,
"error_text": "Successful operation"
}
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |