URL Expired

The URL for this request expired after 30 days.

PublicUpdateCustomFieldDto

• fieldId: string (required) [^\/#!?]+?

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

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

• type: string (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.

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

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

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

• mandatory: boolean
  Whether the field is required to be populated.

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

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

Responses

• 200 Custom field updated successfully

• 400 Invalid request parameters

• 401 Invalid or missing API key

• 500 Internal server error

Example Request

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

Response Codes

• 200
• 400
• 401
• 500