Request body for partial-update of an existing field definition. Every property is optional. null = leave the property unchanged. Empty string ("") on a string property = clear the value. FieldType cannot be changed via this endpoint — use the ChangeFieldType endpoint. ListValues cannot be changed via this endpoint — use the dedicated ListValues endpoints.

Implements

Constructors

Properties

autoExtract?: boolean

Whether values for this field can be automatically extracted by AI/OCR services.

constraint?: string

A validation constraint expression for values stored in this field.

constraintError?: string

The error message returned when the constraint is violated.

currency?: string

The currency for numeric fields when Format is Currency.

defaultValue?: string

The default value applied to entries assigned to a template containing this field.

description?: string

The description of the field.

The display format for the field.

formatPattern?: string

The custom format pattern.

hideListValues?: boolean

Whether list values should be hidden in the UI. Applies only to list-backed fields.

isIndexed?: boolean

Whether the field is indexed for searching.

isIndexedForReporting?: boolean

Whether the field is indexed for reporting.

isMultiValue?: boolean

Whether the field supports multiple values.

isRequired?: boolean

Whether the field is required on entries assigned to a template containing it.

length?: number

The maximum length of the field for variable-length data types.

name?: string

The new name of the field. Must be unique within the repository.

warnIfBlank?: boolean

Whether the user should be warned when leaving the field blank.

Methods

  • Parameters

    • Optional_data: any

    Returns void

  • Parameters

    • Optionaldata: any

    Returns any