Add Custom Field

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

PublicCreateContactCustomFieldDto

Field Type Required Description
type string required Field type that determines business logic behavior. Allowed values: input, dropdown, multiselect, checkbox.
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.
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.
invisibleField boolean required Whether the field should be hidden in the UI.
invisibleLabel boolean required Whether the field label should be hidden in the UI.
leftMenu boolean required Whether the field should appear in the left menu navigation.
mandatory boolean required 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.
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. 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.

Response Codes

Example Request

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

Click to Try It!

Updated 3 months ago