For the complete documentation index, see llms.txt. This page is also available as Markdown.

Масове оновлення балансу монет

Метод зовнішнього API змінює баланс монет одразу для кількох користувачів. Його можна застосовувати для бонусів за акції, компенсацій або синхронізації із зовнішньою системою лояльності.

Метод і авторизація

  • Метод: PATCH /external/api/user_balance/

  • Авторизація: заголовок x-api-key із ключем компанії.

API-ключ створюють у налаштуваннях компанії на вкладці «API-ключі». Як створити ключ.

Параметри тіла запиту

Поле
Значення

userIds

Масив ID користувачів, яким потрібно змінити баланс.

amount

Величина зміни у монетах: додатне число нараховує монети, від'ємне списує.

note

Коментар до зміни балансу.

Перед запуском масового списання перевірте знак і величину amount, а також перелік userIds. Актуальну схему запиту, відповіді та можливі помилки дивіться в Swagger-документації SkillzRun. Доступ до Swagger видає підтримка.