workplaces.workplace.update

Scope: workplaces

Кто может вызывать: Администратор раздела (текущего или нового roomId)

Частичное обновление.

HTTP: POST

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

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

Параметр Тип Обяз. Описание
id int да ID места
typeId int нет enum id (приоритет над type)
type string нет xmlId типа
linkedUserId int нет 0 — снять закрепление
info string[] нет xmlId иконок INFO
size string нет
previewText string нет
pathSvg string нет Рекомендуется передавать
pathSvgPc string нет
active bool нет По умолчанию true

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

result.result: { "id": 1234 }

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

Ответ в едином конверте модуля: result, total, next, error (внутри обёртки Bitrix REST — поле result). Справочник всех кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка
VALIDATION_ERROR Параметр id не передан или ≤ 0
WORKPLACE_NOT_FOUND Рабочее место не найдено
ACCESS_DENIED Нет прав на операцию или объект
USER_NOT_FOUND Пользователь (linkedUserId) не найден

Примеры кода

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/workplaces.workplace.update.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id": 1234, "name": "Место 1 (обновлено)"}'

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

{
          "result": {
            "result": {
              "id": 1234
            },
            "next": null,
            "error": null
          },
          "total": 0
        }
Предыдущая
workplaces.workplace.add
Следующая
workplaces.workplace.delete