Add Custom Field

URL Expired

The URL for this request expired after 30 days.

PublicCreateCustomFieldDto

Field Definition

• fieldId

  • Type: string
  • Required: true
  • Description: Unique identifier of the field used for business logic. Must be unique within the entity.

• label

  • Type: string
  • Required: true
  • Description: Display name of the field shown in the UI.

• category

  • Type: string
  • Required: true
  • Description: Category used for visual grouping of fields in the UI.

• type

  • Type: string (enum)

  • Required: true

  • Description: 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

  • Type: string, number, boolean, array, object
  • Required: true
  • Description: Default value for the field. Varies by field type. Examples: empty string ("") for "input", empty array ([]) for "multiselect", false for "checkbox".

• options

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

Field Visibility

• invisibleField

  • Type: boolean
  • Required: true
  • Description: Whether the field should be hidden in the UI.

• invisibleLabel

  • Type: boolean
  • Required: true
  • Description: Whether the field label should be hidden in the UI.

• leftMenu

  • Type: boolean
  • Required: true
  • Description: Whether the field should appear in the left menu navigation.

• mandatory

  • Type: boolean
  • Required: true
  • Description: Whether the field is required to be populated.

• formula

  • Type: string
  • Description: Formula expression for fields of type "formula". Ignored for other field types.

• extraConfig

  • Type: object
  • Description: 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

  • Type: string
  • Description: 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. Defaults to "NONE" if not provided.

• externalServiceType

  • Type: string (enum)
  • Description: 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. Defaults to "NONE" if not provided. Allowed values: APOLLO, PITCHBOOK, GAIN_PRO, NONE, SELF, CARTA, CARTA_DWH.

Read-Only Field

• readonly

  • Type: boolean
  • Defaults to false
  • Description: Whether the field is read-only and cannot be edited by users.

• condition

  • Type: string
  • Description: Conditional expression that controls field visibility. When set, the field is only shown if the condition evaluates to true. Defaults to empty string (no condition) if not provided.

Response Codes

• 200

  • Description: Custom field created successfully

• 400

  • Description: Invalid request parameters

• 401

  • Description: Invalid or missing API key

• 500

  • Description: Internal server error

Example Curl Command

curl --request POST \
     --url https://crm-public-api.app.carta.com/v1/investors/custom-fields/add \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "type": "input",
  "invisibleField": true,
  "invisibleLabel": true,
  "leftMenu": true,
  "mandatory": true
}
'

Response Format

• application/json
  • Response codes: 200, 400, 401, 500