OmnioDocsAPI referenceOpen the app

Change field

PATCH/v1/custom-fields/{field_id}

Change a field's label, options or position.

field_id is immutable.

Scope crm:admin

Path parameters

field_idstringRequired

Request body

labelstring
1 to 60 characters
optionsarray of string
Up to 100 items
positioninteger
field_idstring

Response

  • 200Success
Response fields
field_idstringRequired
labelstringRequired
typestringRequired
optionsarray of stringRequired
positionintegerRequired
created_atstringRequired

Errors

  • 401unauthorized. The key is missing, unknown or revoked
  • 403insufficient_scope. The key lacks the scope above
  • 403forbidden, or insufficient_scope
  • 404not_found
  • 422field_id_immutable, or validation_error

Every error has the same shape. See Errors.