Приостановить все подписки
Описание
Изменить статус подписок с "subscribed"
на "suspended"
для базы данных подписчиков.
Подписки с другими статусами не изменятся.
URL-адрес
Метод: POST
https://example.com/api/v1.1/subscriptions/suspend_all
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
db_id | int | 1 | Да | Идентификатор базы данных |
channel | int | "email" | Нет | Тип канала |
resource_id | int | 1 | Нет | Идентификатор ресурса |
Если передать параметр "channel"
, то приостановятся подписки на канал.
Если передать параметр "resource_id"
, то приостановятся подписки на ресурс.
Если передать параметры "channel"
и "resource_id"
, то приостановятся подписки на канал и ресурс.
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"db_id": 1,
"channel": "email"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<db_id>1</db_id>
<channel>email</channel>
</xml>
Пример ответа
- JSON
- XML
{
"error": 0,
"error_text": "Successful operation",
"updated": 4080
}
<xml>
<error>0</error>
<error_text>Successful operation</error_text>
<updated>1344</updated>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
updated | int | Количество приостановленных подписок |