gamification.thanks.category.delete

Scope: gamification

Кто может вызывать: Пользователь с правом на изменение настроек модуля (уровень доступа к модулю выше «чтения»; у администратора портала оно есть всегда). Подробнее: Права доступа

Удалить категорию благодарностей — так же, как кнопка удаления строки на вкладке «Спасибо» настроек модуля. Уже отправленные благодарности остаются в истории.

HTTP: POST

Побочные эффекты: удаляется элемент инфоблока категорий, служебные имена оставшихся категорий перенумеровываются.

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

Параметр Тип Обяз. Описание
id int да ID категории (псевдоним: ID)

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

result.result — { "id": <ID>, "deleted": true }.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Нет права на изменение настроек модуля
VALIDATION_ERROR Не передан id
NOT_FOUND Элемент с таким id не является категорией благодарностей
DELETE_FORBIDDEN Удаление отклонено обработчиком модуля или инфоблока

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/gamification.thanks.category.delete.json" \
          -H "Content-Type: application/json" \
          -d '{"id": 812}'
        

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

{
          "result": {
            "result": { "id": 812, "deleted": true },
            "total": null,
            "next": null,
            "error": null
          }
        }
        

См. также