Update Custom Field

URL Expired

The URL for this request expired after 30 days.

FieldId

Type: string
Required: Yes
Format: [^\/#!?]+?

PublicUpdateCustomFieldDto

• label
  Display name of the field shown in the UI.
• category
  Category used for visual grouping of fields in the UI.
• type
  Enum:
  Field type that determines business logic behavior. Allowed values: input, textarea, dropdown, datepicker, multiselect, users-array, contacts-list, checkbox, number, formula, deal, deal-list, company, company-list, attachment, url-link.

Allowed Values: input, textarea, dropdown, datepicker, multiselect, users-array, contacts-list, checkbox, number, formula, deal, deal-list, company, company-list, attachment, url-link.

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

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

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

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

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

• mandatory
  Whether the field is required to be populated.

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

• extraConfig
  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
  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
  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.

Allowed: APOLLO, PITCHBOOK, GAIN_PRO, NONE, SELF, CARTA, CARTA_DWH.

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

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

Response Codes

• 200 Custom field updated successfully
• 400 Invalid request parameters
• 401 Invalid or missing API key
• 500 Internal server error

Shell Commands

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

Response Example

{"status":"200"}