URL Expired

The URL for this request expired after 30 days.

PublicCreateCustomFieldDto

fieldId
string
required
Unique identifier of the field used for business logic. Must be unique within the entity.

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

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

type
string
enum
required
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.

inputtextareadropdowndatepickermultiselectusers-arraycontacts-listcheckboxnumberformuladealdeal-listcompanycompany-listattachmenturl-link

Show 16 enum values

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

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

options*

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

truefalse

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

truefalse

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

truefalse

mandatory
b boolean
required
Whether the field is required to be populated.

truefalse

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. Defaults to "NONE" if not provided.

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. Defaults to "NONE" if not provided. Allowed values: APOLLO, PITCHBOOK, GAIN_PRO, NONE, SELF, CARTA, CARTA_DWH.

Allowed:
APOLLO PITCHBOOK GAIN_PRO NONE SELF CARTA CARTA_DWH

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

truefalse

condition
string
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.

``200 Custom field created successfully

``400 Invalid request parameters

``401 Invalid or missing API key

``500 Internal server error

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

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

application/json

200400401500