gamification.rating.update

Scope: gamification

Кто может вызывать: Только admin или manager. Подробнее: Права доступа

Обновить поля рейтинга и/или его параметры стратегии (arParams).

HTTP: POST

Побочные эффекты: изменяет запись рейтинга в базе.

Параметры метода

Параметр Тип Обяз. Описание
id int да ID рейтинга
fields object нет Поля рейтинга для обновления
arParams object нет Параметры стратегии рейтинга
img string нет URL или base64 иконки (псевдоним: ICON)

Возвращаемые данные

result.result — объект обновлённого рейтинга.

Обработка ошибок

Справочник кодов ошибок.

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Вызывающий не является admin/manager
VALIDATION_ERROR Не передан id; fields или arParams не является объектом
NOT_FOUND Рейтинг не найден

Пример запроса (POST)

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/gamification.rating.update.json" \
          -H "Content-Type: application/json" \
          -d '{"id": 1, "fields": {"STATUS": "active"}}'
Предыдущая
gamification.rating.get
Следующая
gamification.rating.recalculate