fields

Update a field

put/sheets/{sheetId}/fields/{fieldKey}

Request

  • Base URL: https://api.orcascan.com/v1
  • URL: https://api.orcascan.com/v1/sheets/{sheetId}/fields/{fieldKey}
  • Auth: HTTP bearer

Request body

labelstring

Field display name

format'text' | 'barcode' | 'number' | 'number (auto increase on scan)' | 'number (auto decrease on scan)' | 'date' | 'date (automatic)' | 'date time' | 'date time (automatic)' | 'time' | 'email' | 'gps location' | 'gps location (automatic)' | 'true/false' | 'currency' | 'drop-down list' | 'formula' | 'signature' | 'unique id' | 'photo' | 'attachment' | 'url' | 'created by' | 'created date' | 'last modified by' | 'last modified date'

Field data type

defaultstring

Default value for new rows

multiSelectboolean

Allow multiple selections for drop-down list fields

formulastring

Formula for formula fields, using column names in square brackets, e.g. [Quantity] * [Price] (numbers only)

currencyTypestring

3-letter currency code for currency fields

lockedboolean

Prevent field from being edited

minLengthinteger

Minimum text length

maxLengthinteger

Maximum text length

minimumnumber

Minimum numeric value

maximumnumber

Maximum numeric value

placeholderstring

Placeholder text shown when field is empty

prefixstring

Text prefix displayed before the value

suffixstring

Text suffix displayed after the value

lengthinteger

Fixed length for unique ID fields

requiredboolean

Whether the field must have a value

autofocusboolean

Automatically focus this field on mobile

autoselectboolean

Automatically select field content on focus

emptyOnEditboolean

Clear field value when editing a row

emptyOnScanboolean

Clear field value when scanning a barcode

hiddenMobileboolean

Hide field on mobile devices

hiddenWebboolean

Hide field in web interface

readonlyWebboolean

Make field read-only in web interface

readonlyMobileboolean

Make field read-only on mobile devices

useInMobileSearchboolean

Include field in mobile search results

useValueInListboolean

Show field value in mobile list view

allowDuplicatesboolean

Allow duplicate values (barcode field only)

indexinteger

Display order position

keystring

Field key identifier (used in bulk upsert to target existing fields)

Response

Updated field wrapped in data envelope

Changes

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