polls.vote.channel.update

Scope: polls

Кто может вызывать: Администратор модуля «Опросы». Группу, привязанную к нескольким сайтам (департаментам) или к другому сайту, может менять только полный администратор портала — как в интерфейсе. Подробнее: Права доступа

Изменение группы опросов (канала). Меняются только переданные поля.

HTTP: POST

Побочные эффекты:

  • изменяет канал опросов;
  • при передаче visible добавляет символьный код в visible_channels сайтов группы или удаляет его оттуда;
  • сбрасывает кеш списка каналов.

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

Параметр Тип Обяз. Описание
id int да ID группы
title string нет Название; правила — как в polls.vote.channel.add
symbolicName string нет Символьный код задаётся при создании и не меняется: можно передать только текущее значение, иное — VALIDATION_ERROR
active string нет Y/N или bool
voteSingle string нет Y/N или bool
sort int нет Сортировка (≥ 0)
siteIds array нет Коды сайтов (alias sites). Полный администратор задаёт список; для остальных и при пустом значении — текущий сайт, как в интерфейсе
visible string нет Y/N или bool: показывать группу на странице опросов сайтов группы. Не передан — настройка не меняется
fields object нет Необязательная обёртка с теми же полями

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

Ответ в конверте модуля: result.result — группа после изменения в формате polls.vote.channel.get; result.error.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера
ACCESS_DENIED Пользователь не администратор модуля; группа привязана к нескольким сайтам или не к текущему сайту, а пользователь не полный администратор (details.reason=LOCKED); системная группа «Без группы» (details.reason=SYSTEM_CHANNEL)
NOT_FOUND Группа не найдена
VALIDATION_ERROR Не передан id; недопустимое значение поля; попытка сменить symbolicName (details.reason=SYMBOLIC_NAME_IMMUTABLE)

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/polls.vote.channel.update.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
          "id": 12,
          "title": "Адаптация новых сотрудников",
          "active": "N"
        }'

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

{
          "result": {
            "result": {
              "id": 12,
              "title": "Адаптация новых сотрудников",
              "active": "N",
              "sites": "s1",
              "siteIds": ["s1"],
              "symbolicName": "ONBOARDING",
              "sort": 600,
              "voteSingle": false,
              "visible": true,
              "pulse": false,
              "pollCount": 3
            },
            "error": null
          }
        }

См. также

Предыдущая
vote.channel.list
Следующая
vote.clearCache