POST
{api-domain}/crm/{version}/settings/fields?module={module_API_name}
|
Field Type (UI)
|
Field Data Type
|
Single Line
|
text
|
Multi-Line
|
textarea
|
Email
|
|
Phone
|
phone
|
Pick List
|
picklist
|
Multi Select
|
multiselectpicklist
|
Date
|
date
|
Date/Time
|
datetime
|
Number
|
integer
|
Auto-Number
|
autonumber
|
Currency
|
currency
|
Decimal
|
double
|
Percent
|
percent (only in POST)
|
Long Integer
|
bigint
|
Checkbox
|
Boolean
|
URL
|
website
|
Lookup
|
lookup
|
Formula
|
formula
|
User (Type- Single User)
|
userlookup |
User (Type- Multiple Users)
|
multiuserlookup
|
File Upload
|
fileupload
|
Image Upload
|
imageupload
|
Rollup Summary
|
rollup_summary
|
Multi-Select Lookup
|
multiselectlookup
|
{
"fields": [
{
"field_label": "Your Field Label",
"data_type": "<field_type>",
"length": "<length>",
"tooltip": {
"name": "static_text",
"value": "Tooltip message"
},
"profiles": [
{
"id": "<profile_id_1>",
"permission_type": "read_write"
},
{
"id": "<profile_id_2>",
"permission_type": "read_only"
}
],
"external": {
"type": "user",
"show": false
},
"crypt": {
"mode": "decryption"
}
}
]
}
|
Key
|
Mandatory
|
Description
|
field_label
|
Yes
|
Display name of the field
|
date_type
|
Yes
|
Field type
|
length
|
No
|
Max number of characters allowed for a field |
filterable
|
No
|
Whether field can be used in filters. When set to true, the field will be available for use in Criteria Pattern Editors. Note that it is not applicable for imageupload, fileupload, textarea, and formula fields |
tooltip
|
No |
Field help text; name can be static_text or info_icon
|
profiles
|
No
|
Access control per profile (read_write, read_only, hidden)
|
crypt |
No
|
Whether to encrypt the field (encryption or decryption)
|
unique
|
No
|
Enforce uniqueness across records
|
hipaa_compliance_enabled
|
No
|
Enable HIPAA protection
|
private
|
No
|
Enable GDPR-level handling (Low or High)
|
{
"fields": [
{
"data_type": "text",
"field_label": "External ID",
"external": {
"type": "org",
"show": true
}
}
]
}
|
Multi-line field type
|
Character limit
|
Can be marked Mandatory?
|
Can be Encrypted?
|
Plain text small
|
Up to 2000
|
Yes
|
Yes
|
Plain text large
|
Up to 32000
|
Yes
|
No
|
Rich text (RTF)
|
Up to 50000
|
No
|
No
|
{
"fields": [
{
"field_label": "Apartment_details",
"data_type": "textarea",
"length" : 2000,
"textarea": {
"type": "small"
}
}
]
}
|
This type of multi line field is ideal for more extensive entries of up to 32000 character size. To create a plain text large multi line field, give data_type as textarea and type key in text area JSON object as "large".
{
"fields": [
{
"field_label": "Apartment_details",
"data_type": "textarea",
"length" : 32000,
"textarea": {
"type": "large"
}
}
]
}
|
{
"fields": [
{
"field_label": "Apartment_details",
"data_type": "textarea",
"length" : 50000,
"textarea": {
"type": "rich_text"
}
}
]
}
|
{
"fields": [
{
"field_label": "Your picklist's field label",
"data_type": "picklist",
"enable_colour_code": true,
"history_tracking_enabled": true,
"pick_list_values": [
{
"display_value": "Option 1",
"colour_code": "#af38fa",
"actual_value": "Option 1"
},
{
"display_value": "Option 2",
"colour_code": "#ffd6bc",
"actual_value": "Option 2"
},
{
"display_value": "Option 3",
"colour_code": "#cfddbc",
"actual_value": "Option 3"
}
]
}
]
}
|
{
"fields": [
{
"field_label": "Source",
"data_type": "picklist",
"global_picklist": {
"id": "72223455366"//Id of the global picklist
}
}
]
}
|
{
"fields": [
{
"field_label": "Preferred working days",
"data_type": "multiselectpicklist", // Specify the data type as multiselectpicklist*
"pick_list_values": [
{
"display_value": "Monday",
"actual_value": "1"
},
{
"display_value": "Tuesday",
"actual_value": "2"
},
{
"display_value": "Wednesday",
"actual_value": "3"
},
{
"display_value": "Thursday",
"actual_value": "4"
},
{
"display_value": "Friday",
"actual_value": "5"
}
],
"pick_list_values_sorted_lexically": true,
"enable_colour_code": true
}
]
}
|
{
"fields": [
{
"field_label": "Order ID",
"data_type": "autonumber",
"auto_number": {
"start_number": 1000,
"prefix": "ORD-",
"suffix": "-2025",
"_update_existing_records": true
}
}
]
}
|
{
"fields": [
{
"field_label": "Deal Amount",
"data_type": "currency",
"currency": {
"rounding_option": "round_up",
"precision": 2,
"decimal_place": 3
}
}
]
}
|
{
"fields": [
{
"field_label": "Discount Rate",
"data_type": "double",
"length": 16,
"decimal_place": 2
}
]
}
|
{
"fields": [
{
"field_label": "Enrollment number",
"data_type": "bigint",
"length": 18,
"separator": true
}
]
}
|
{
"fields": [
{
"field_label": "Enrollment number",
"data_type": "bigint",
"length": 18,
"separator": true
}
]
}
|
{
"fields": [
{
"field_label": "Previously Employed?",
"data_type": "boolean"
}
]
}
|
{
"fields": [
{
"field_label": "Your lookup",
"data_type": "lookup",
"lookup": {
"module": {
"api_name": "Contacts"
},
"display_label": "Contact Lookup",
"revalidate_filter_during_edit": true,
"query_details": {
"criteria": {
"group_operator": "AND",
"group": [
{
"field": {
"api_name": "Phone"
},
"comparator": "contains",
"value": "91"
},
{
"field": {
"api_name": "Lead_Source"
},
"comparator": "equal",
"value": [
"Cold Call"
]
}
]
}
}
}
}
]
}
|
{
"fields": [
{
"field_label": "Total amount",
"data_type": "formula",
"formula": {
"return_type": "double",
"expression": "${Amount} + 150"
},
"decimal_place": 0,
"number_separator": false
}
]
}
|
{
"fields": [
{
"field_label": "Deal Age",
"data_type": "formula",
"formula": {
"expression": "Datecomp(${Created_Time},Now())",
"return_type": "double",
"dynamic": true,
"stop_compute_conditionally": true,
"stop_compute_expression": "${Probability}==100"//When the deal probability is 100, the calculation gets stopped.
}
}
]
}
|
{
"fields": [
{
"field_label": "Assigned Sales Rep",
"data_type": "userlookup",
"tooltip": {
"name": "info_icon",
"value": "Sales user responsible for this lead"
},
"lookup": {
"revalidate_filter_during_edit": true,
//associate only users from countries India, and email containing "zylker.com".
"query_details": {
"criteria": {
"group_operator": "AND",
"group": [
{
"field": {
"api_name": "country"
},
"comparator": "equal",
"value": "India"
},
{
"field": {
"api_name": "email"
},
"comparator": "contains",
"value": "@zylker.com"
}
]
}
}
},
"sharing_properties": {
"share_preference_enabled": true,
"share_permission": "read-only"
}
}
]
}
|
{
"fields": [
{
"field_label": "Associated_Agents",
"data_type": "multiuserlookup",
"multiuserlookup": {
"record_access": true
}
}
]
}
|
{
"fields": [
{
"field_label": "Resume Upload",
"data_type": "fileupload",
"length": 1,// Allow only 1 file, Maximum length : 5
"tooltip": {
"name": "info_icon",
"value": "Upload the applicant's resume in PDF or DOC format"
}
}
]
}
|
{
"fields": [
{
"field_label": "Profile Photo",
"data_type": "imageupload",
"length": 1, // Only 1 profile photo allowed, Maximum length 10
"tooltip": {
"name": "info_icon",
"value": "Upload a professional head shot for the employee record"
}
}
]
}
|
{
"fields": [
{
"field_label": "Total Invoice Amount",
"data_type": "rollup_summary",
"rollup_summary": {
"return_type": "currency",
"expression": {
"function_parameters": [
{
"api_name": "Grand_Total"
}
],
"criteria": {
"group_operator": "AND",
"group": [
{
"comparator": "equal",
"field": {
"api_name": "Billing_Country"
},
"value": "United States"
},
{
"comparator": "greater_than",
"field": {
"api_name": "Invoice_Date"
},
"value": "2024-01-01"
}
]
},
"function": "SUM"
},
"based_on_module": {
"api_name": "Invoices"
},
"related_list": {
"api_name": "Invoices"
}
}
}
]
}
|
{
"fields": [
{
"field_label": "Skills",
"data_type": "multiselectlookup",
"multiselectlookup": {
"connected_details": {
"module": {
"api_name": "Skills"
},
"field": {
"field_label": "SkillName"
}
},
"linking_details": {
"module": {
"plural_label": "EmpXSkill"
}
}
}
}
]
}
|