Update Custom Field

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

fieldId
string
required
[^\/#!?]+?

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

input``dropdown``multiselect``checkbox

label
string
Display name of the field shown in the UI.

category
string
Category used for visual grouping of fields in the UI.

default
string | number | boolean | array | object
Default value for the field. Varies by field type. Examples: empty string ("") for "input", empty array ([]) for "multiselect", false for "checkbox".

options
array
Additional configuration for field types that support predefined values, such as "multiselect", "dropdown". Defines the list of selectable options for these field types.

invisibleField
boolean
Whether the field should be hidden in the UI.

true/false

invisibleLabel
boolean
Whether the field label should be hidden in the UI.

true/false

leftMenu
boolean
Whether the field should appear in the left menu navigation.

true/false

mandatory
boolean
Whether the field is required to be populated.

true/false

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

extraConfig
object
Extra configuration for field formatting and display. Applicable to field types that support value formatting, such as "formula", "number", and others. Controls how the field value is rendered (e.g. number of decimal points, suffix, date format).

externalServiceFieldPath
string
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
string
enum
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.

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

true/false

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

Response Codes

Updated 3 months ago

Shell Examples 

xxxxxxxxxx

curl --request PATCH \
     --url https://crm-public-api.app.carta.com/v1/contacts/custom-fields/fieldId \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

Updated 3 months ago