Edit

[POST] .../v1/field/edit

Edits additional field. Use this method to update a custom additional field definition after reading it with Field/Get. The request requires id and may change name, required and metadata; key, entity_type, data_type and is_custom cannot be changed by this endpoint. At least one editable field must be supplied; empty metadata clears the stored metadata value, while null metadata leaves it unchanged. Only custom fields can be edited, the caller must have additional field edit permission and the account tariff must allow additional fields. Missing body, invalid id, denied permission, disabled tariff option, missing field, system field edit attempts, no editable fields, invalid string lengths, action-log errors and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
id Int64 Required Field ID.
metadata String Optional Field metadata. Maximum length is 500 characters including escaping.
name String Optional Field name. Optional and limited to 120 characters by current validation when sent.
required Boolean Optional Indicates whether the field is required.

Request Example

{
  "id": 12,
  "name": "Supplier color code",
  "required": false,
  "metadata": ""
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

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