Главная / База знаний / API документация / Методы: создание и отправка сообщений / Метод cancelCampaign

Метод cancelCampaign

Общая информация
Методы: работа со списками контактов
Методы: создание и отправка сообщений
Методы: получение статистики
Методы: работа с шаблонами
Методы: работа с дополнительными полями и метками
Методы: работа с заметками

Метод для отмены запланированной рассылки. Пользователь может отменить свою рассылку с указанным campaign_id (его можно получить после создания рассылки - метод createCampaign).

Рассылку можно отменить, если она находится в одном из статусов: «Планируется», «Запланирована» (scheduled), «Рассматривается администрацией» (censor_hold), «Ожидает одобрения» (waits_censor). Статус рассылки можно получить с помощью метода getCampaignStatus.

Принцип использования

Синтаксис и URL для вызова метода
cancelCampaign (int campaign_id)
https://api.unisender.com/ru/api/cancelCampaign?api_key=API_KEY&campaign_id=ID
Аргументы
api_key * Ключ доступа к API.
campaign_id * id рассылки, которую необходимо отменить.
Возвращаемое значение
Если рассылка успешно отменена:

{"result":[]}

Если рассылка не может быть отменена:

  • если такой рассылки не существует: 
    {
  "error":"SB140212-01. 
  [Burst not found. Provided Id: 1111]",
   "code":"unspecified",
   "result":""
 }
  • если рассылка принадлежит другому пользователю 
    {
  "error":"Access denied to this resource",
  "code":"unspecified",
  "result":""
}
  • если рассылка в недоступном для отмены статусе 
    {
  "error":"SF161129-03 
  [Campaign in status "canceled" can't be cancelled]",
  "code":"unspecified",
  "result":""
}

Вы нашли ответ?

0
0