Добавление пин-кода (campaign/add-pins)

Метод добавляет пин-коды к существующей кампании. Доступен только для кампаний с одноразовыми пин-кодами:

campaignType=codeOnline или campaignType=codeOffline;
и pinType=one-off.

Если кампания находится в статусе pin-required (кампания не запущена, так как закончились пин-коды), то после добавления пин-кодов кампания запустится автоматически.

Запрос

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

POST https://yoomoney.ru/api/offerwall/v1/campaigns/add-pins

Параметры

Параметр	Тип	Описание
partnerCampaignId	int	Идентификатор кампании. Возвращается в ответе на запрос campaigns/create. Обязательный параметр
pinList	массив строк	Множество пин-кодов, которые будут действовать для этой кампании. Обязательный параметр

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

JSON

{
    "ymCampaignId": 60,
    "pinList": [
        "dykLadno",
        "storubley",
        "1234567"
    ]
}

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

cURL

curl -X POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer: <авторизационный токен>' \
  -d '{
    "ymCampaignId": 60,
    "pinList": [
        "dykLadno",
        "storubley",
        "1234567"
    ]
}' 'https://yoomoney.ru/api/offerwall/v1/campaigns/add-pins'

Ответ

Параметры

Параметр	Тип	Описание
ymCampaignId	int	Уникальный идентификатор кампании.
campaignStatus	enum	Статус кампании.
counters	объект	Счетчики пин-кодов.
unusedPinCount	int	Количество неиспользованных пин-кодов (сколько осталось).
acceptedPinCount	int	Количество пин-кодов, полученных пользователями.
redeemedPinCount	int	Количество использованных пользователем пин-кодов. Передается магазином или агрегатором в запросе campaigns/redeem.
totalPinCount	int	Всего пин-кодов.

Ошибки

Код ошибки	Значение	Описание
incorrectData	Некорректные данные	В запросе переданы некорректные данные.

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

JSON

{
    "status": "success",
    "result": {
        "ymCampaignId": 60,
        "campaignStatus": "started",
        "counters": {
            "unusedPinCount": 7,
            "acceptedPinCount": 0,
            "redeemedPinCount": 0,
            "totalPinCount": 7
        }
    }
}