Update custom field

Updates an existing custom field by its ID.

Note: Changing the type or scope of a field may affect existing data. Use with caution.

Path Parameters

ParameterTypeRequiredDescription
idintegerYesCustom field unique identifier

Body Fields

FieldTypeRequiredDescription
namestringNoInternal field name
labelstringNoDisplay label shown in the UI
typestringNoField type
scopestringNoEntity scope
requiredbooleanNoWhether the field is mandatory
formulastringNoFormula expression
optionsobjectNoOptions for Select/MultiSelect
weightintegerNoSort order/priority
sizestringNoCSS width class
editablebooleanNoWhether users can edit
publicbooleanNoWhether visible publicly
activatebooleanNoWhether the field is active
enableAibooleanNoEnable AI features
hubspotMapstringNoHubSpot property mapping
isMappedToHubspotbooleanNoEnable HubSpot sync

Response Fields

FieldTypeDescription
idintegerCustom field unique identifier
namestringInternal field name
labelstringDisplay label
typestringField type
scopestringEntity scope
requiredbooleanWhether mandatory
activatebooleanWhether active
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp

Response

  • 200 OK: Custom field successfully updated
  • 400 Bad Request: Invalid request body or validation error
  • 401 Unauthorized: Invalid or missing API key
  • 404 Not Found: Custom field not found
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
string
boolean
integer
Responses
200

Resource updated

400

Bad request

401

Unauthorized

404

Resource not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!