Custom Fields

Update a custom field definition

Update the label, description, section, flags or type-specific settings of a definition, or deactivate it with {"is_active": false} (stored values are kept). Requires update:custom_field_definitions.

entity_type, field_key and field_type cannot be changed; a body naming them is rejected with 400.

patch/v1/custom-field-definitions/{id}

Request

  • Base URL: https://api.workwing.io
  • URL: https://api.workwing.io/v1/custom-field-definitions/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Headers

Idempotency-Keystring required

Unique per write, 1-256 printable ASCII characters. Retrying with the same key and the same request replays the original response for 24 hours. See Idempotency.

Request body

field_labelstring
field_descriptionstring nullable
display_sectionstring nullable
is_requiredboolean
is_searchableboolean
is_filterableboolean
field_configobject

Type-specific settings: minLength/maxLength/pattern for text, min/max/step/unit for numbers, minDate/maxDate for dates, options for select and multiselect, allowedBarcodeTypes/scannerHint for scanner.

is_activeboolean

false deactivates the field and hides it from forms and the list; values are kept

Response

Default Response

Changes

No recorded changes to this operation across all 1 revision of this API.