30.09.2025 14:05

Edit

[POST] …/v1/field/edit

Редактирование дополнительного поля.

Важно: Нельзя отредактировать поле с флагом is_custom = false.

Входные параметры

Название Тип данных Обязательность Описание
id Int64 Обязательный id поля
name String Необязательный Наименование поля
metadata String Необязательный Метаданные поля. Максимальная длина — 500 символов с учётом экранирования
required Boolean Необязательный Обязательность поля для данных (true/false)

Нюанс очистки metadata: если передать пустую строку "", значение будет очищено (сохранится null). Если поле metadata не передано в запросе — текущее значение не изменяется.

Пример запроса

{
  "id": 201,
  "name": "ИНН контрагента",
  "metadata": "",
  "required": true
}

Выходные параметры

Название Тип данных Описание
row_affected Int64 Количество изменённых строк

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

{
    "ok": true,
    "result": {
        "row_affected": 1
    }
}