Остановка кампании (campaigns/stop)

Метод прекращает показы кампании и отправляет ее в архив.

Запрос

Адрес для отправки запроса

POST https://yoomoney.ru/api/offerwall/v1/campaigns/stop

Параметры

Параметр	Тип	Описание
partnerCampaignId	int	Идентификатор кампании. Возвращается в ответе на запрос campaigns/create.

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

JSON
{
    "ymCampaignId": 34
}

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

cURL
curl -X POST \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <авторизационный токен>'  -d '{
    "ymCampaignId": 34
    }' 'https://yoomoney.ru/api/offerwall/v1/campaigns/stop'

Ответ

Параметры

Параметр	Тип	Описание
ymCampaignId	int	Уникальный идентификатор кампании.
campaignStatus	enum	Статус кампании. При успешной остановке кампании вернется статус `paused`. В случае ошибки вернется текущий статус кампании. Все статусы кампании

Ошибки

Код ошибки	Значение	Описание
failMerchant	Нет прав	Кампания может быть остановлена только агрегатором или магазином, который ее создал.
failFinished	В архиве	Кампания была удалена.

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

JSON
{
  "errors": {},
  "result": {
    "campaignStatus": "paused",
    "ymCampaignId": 34
  },
  "status": "success"
}