Sign in

v1

latestOpenAPI 3.0.02026-07-24186151303.4 KB
Contacts

Update Custom Field

Partially updates an existing custom field in the contact schema. Only the fields provided in the request body will be modified.

patch/v1/contacts/custom-fields/{fieldId}

Path parameters

fieldIdstring required

Request body

type'input' | 'dropdown' | 'multiselect' | 'checkbox'

Field type that determines business logic behavior. Allowed values: input, dropdown, multiselect, checkbox.

labelstring

Display name of the field shown in the UI.

categorystring

Category used for visual grouping of fields in the UI.

invisibleFieldboolean

Whether the field should be hidden in the UI.

invisibleLabelboolean

Whether the field label should be hidden in the UI.

leftMenuboolean

Whether the field should appear in the left menu navigation.

mandatoryboolean

Whether the field is required to be populated.

formulastring

Formula expression for fields of type "formula". Ignored for other field types.

externalServiceFieldPathstring

Field path used to map data from an external service response. Supports dot notation for nested properties (e.g. "employees.current_count"). Must be used together with externalServiceType.

externalServiceType'APOLLO' | 'PITCHBOOK' | 'GAIN_PRO' | 'NONE' | 'SELF' | 'CARTA' | 'CARTA_DWH'

External service used for automatic field enrichment. The target entity must have the corresponding external service integration enabled, otherwise the field will not be enriched. Must be used together with externalServiceFieldPath. Allowed values: APOLLO, PITCHBOOK, GAIN_PRO, NONE, SELF, CARTA, CARTA_DWH.

readonlyboolean

Whether the field is read-only and cannot be edited by users.

conditionstring

Conditional expression that controls field visibility. When set, the field is only shown if the condition evaluates to true.

Response

Custom field updated successfully

fieldIdstring required
labelstring required
categorystring required
{"stackTrail":"components:schemas:PublicCustomFieldDto:properties:default","oasType":"schema","type":"unknown"}
invisibleFieldboolean required
invisibleLabelboolean required
leftMenuboolean required
mandatoryboolean required
tabNamestring required
type'input' | 'textarea' | 'dropdown' | 'datepicker' | 'multiselect' | 'users-array' | 'contacts-list' | 'checkbox' | 'number' | 'texteditor' | 'tags' | 'formula' | 'deal' | 'deal-list' | 'company' | 'company-list' | 'attachment' | 'url-link' | 'fixed' required
externalServiceFieldPathstring

Field path used to map data from an external service response. Supports dot notation for nested properties (e.g. "employees.current_count").

externalServiceType'APOLLO' | 'PITCHBOOK' | 'GAIN_PRO' | 'NONE' | 'SELF' | 'CARTA' | 'CARTA_DWH'

External service used for automatic field enrichment. Allowed values: APOLLO, PITCHBOOK, GAIN_PRO, NONE, SELF, CARTA, CARTA_DWH.

formulastring

Formula expression for fields of type "formula".

readonlyboolean

Whether the field is read-only and cannot be edited by users.

conditionstring

Conditional expression that controls field visibility.