На этой странице находится старая версия документации Altcraft Platform.
Актуальную информацию вы найдёте, перейдя по ссылке https://guides.altcraft.com.

Описание

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

Подписка останется в профиле, но получит метку: "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

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

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

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

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

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

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