v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Company Objects

Partial Update Custom Field

patch/ca/api/v1/custom-fields/{id}

Path parameters

idinteger required

Request body

idinteger
appstring
modelstring
namestring
labelstring
field_type'text' | 'single_select' | 'date' | 'number' | 'boolean'
  • text - Free Text
  • single_select - Single Select
  • date - Date
  • number - Number
  • boolean - Boolean
{"stackTrail":"components:schemas:PatchedCustomField:properties:options","oasType":"schema","type":"unknown"}
is_requiredboolean
display_orderinteger
is_activeboolean
include_on_invoiceboolean
created_atstring date-time
updated_atstring date-time
last_modified_atstring date-time
is_deletedboolean
deleted_atstring date-time nullable

Response

idinteger required
appstring required
modelstring required
namestring required
labelstring required
field_type'text' | 'single_select' | 'date' | 'number' | 'boolean' required
  • text - Free Text
  • single_select - Single Select
  • date - Date
  • number - Number
  • boolean - Boolean
{"stackTrail":"components:schemas:CustomField:properties:options","oasType":"schema","type":"unknown"}
is_requiredboolean
display_orderinteger
is_activeboolean
include_on_invoiceboolean
created_atstring date-time required
updated_atstring date-time required
last_modified_atstring date-time required
is_deletedboolean required
deleted_atstring date-time nullable required