Запуск кампании (campaigns/start)
Метод запускает существующую кампанию из статуса
paused
и переводит в статус started
.Запрос
Адрес для отправки запроса
POST https://yoomoney.ru/api/offerwall/v1/campaigns/start
Параметры
Параметр | Тип | Описание |
---|---|---|
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/start'
Ответ
Параметры
Параметр | Тип | Описание |
---|---|---|
ymCampaignId | int | Идентификатор кампании. |
campaignStatus | enum | Статус кампании. При успешном запуске вернется статус started . В случае ошибки запуска вернется текущий статус кампании. |
Ошибки
Код ошибки | Значение | Описание |
---|---|---|
failPin | Нет пин-кодов | Кампания этого типа не может быть запущена без пин-кодов. |
failFinished | Завершена | Эта кампания завершена. |
failModerator | На модерации | Кампания ждет проверки. |
campaignNotFound | Не найдена | Кампания с таким ymCampaignId у этого агрегатора или магазина не существует. |
Пример тела ответа
JSON
{ "status": "success", "result": { "ymCampaignId": 34, "campaignStatus": "started" } }