v1

latestOpenAPI 3.1.1LicenseRef-Proprietary2026-07-1310179223.1 KB

Custom Fields

Update Field

Update a custom field's name, type-specific options, or visibility.

put/fields/{field_id}

Path parameters

field_idnumber required

Example:4456411

Field ID

Request body

namestring

type'number' | 'text' | 'select' | 'date'

iconstring

Example request

{
  "name": "field name",
  "type": "select",
  "format": {
    "decimals": 2,
    "label": "US$"
  },
  "options": [
    {
      "id": 806,
      "name": "option value",
      "color": "#FC5500"
    }
  ]
}

Response

idnumber

Custom field ID

namestring

typestring

positionnumber

iconstring

Field icon name

Example response

{
  "id": 406,
  "name": "field name",
  "type": "date",
  "format": {
    "decimals": 2,
    "label": "US$"
  },
  "options": [
    {
      "id": 806,
      "name": "option value",
      "color": "#FC5500"
    }
  ],
  "position": 1
}