Delete

[POST] .../v1/field/delete

Deletes additional field. Use this method to permanently delete a custom additional field definition after confirming it is no longer needed. The request requires id; only custom fields can be deleted and fields that already have stored values are rejected. The caller must have additional field delete permission and the account tariff must allow additional fields. Typical workflow is Field/Get to inspect the field, entity updates to remove existing custom values if needed, then Field/Delete. Missing body, invalid id, denied permission, disabled tariff option, missing field, system field delete attempts, fields with stored values, action-log errors and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
id Int64 Required Record ID.

Request Example

{
  "id": 12
}

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
  }
}