×

Получи 5 готовых email-стратегий для любого бизнеса БЕСПЛАТНО!

После регистрации

меню
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

Метод cancelCampaign

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

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

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

Синтаксис и URL для вызова метода
cancelCampaign (int campaign_id)
https://unisender.host.com/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":""
    }