Documentation

crm.lead.fields

crm.lead.fields()

Returns the description of the fields available to a lead.

Returns the lead fields description, including user fields.

Parameters

No parameters.

Example

<script type="text/javascript">
	BX24.callMethod(
			"crm.lead.fields", 
			{}, 
			function(result) 
			{
				if(result.error())
					console.error(result.error());
				else
					console.dir(result.data());
			}
		);		
</script>

Fields

Field DescriptionTypeNote
ADDRESS Contact addressstring
ADDRESS_2 Second page of the addressstringIn some countries it is customary to split an address into 2 parts
ADDRESS_CITY Citystring
ADDRESS_COUNTRY Countrystring
ADDRESS_COUNTRY_CODE Country codestring
ADDRESS_POSTAL_CODE Postal codestring
ADDRESS_PROVINCE Provincestring
ADDRESS_REGION Regionstring
ASSIGNED_BY_ID Associated with user by IDuser
BIRTHDAY Date of birthdate
COMMENTS Commentsstring
COMPANY_ID Linking a contact to a companycrm_companyRead only
COMPANY_TITLE Name of company, associated with a leadcrm_company
CONTACT_ID Linking a lead to a contactcrm_contact Read only
CREATED_DY_ID Who createduserRead only
DATA_CREATE Creation datedatetimeRead only
DATA_MODIFY Date modifieddatetimeRead only
EMAIL E-mail addresscrm_multifieldMultiple
HAS_MAIL E-mail field fill-up checkcharRead only
HAS_PHONE Telephone field fill-up checkcharRead only
HONORIFIC Request typecrm_status
ID Contact ID integerRead only
IM Messengerscrm_multifieldMultiple
IS_RETURN_CASTOMER charRead only
MODIFY_BY_ID Last modification author IDuserRead only
NAME NamestringRequired
OPENED Accessible for allchar
ORIGINATOR_ID Data source IDstringUsed only to link to to an external source.
ORIGIN_ID Element ID in the data sourcestringUsed only to link to to an external source.
ORIGIN_VERSION Original versionstringUsed only for protection from random deletion by an external system. If the data is imported and was not modified in the external system, then such data can be safely edited in CRM and that the next download will not overwrite the data.
PHONE Contact telephonecrm_multifieldMultiple
PHOTO Contact photofile
POST Positionstring
SECOND_NAME Second namestringRequired
SOURCE_DESCRIPTION Source description?string
SOURCE_ID Source IDcrm_statusStatus from directory
STATUS_DESCRIPTION string
STATUS_ID string
STATUS_SEMANTIC_ID string
TITLE Lead namestringRequired
UTM_CAMPAIGN Advertisement campaign designationstring
UTM_CONTENT Campaign contentstringFor example, for context announcements.
UTM_MEDIUM Type of trafficstringCPC (announcements), CPM (banners)
UTM_SOURCE Advertisement systemstringYandex-Direct, Google-Adwords and others.
UTM_TERM Campaign search conditionstringFor example, contextual advertising keywords.
WEB URL for contact resourcescrm_multifieldMultiple


User Comments

User comments are not part of official documentation. Use information provided by other users in the comments at your own risk.

The User Comments section is not to be used as a feature discussion board. Only registered users can post comments. Your comment will be visible once it has been approved by the moderator.
© «Bitrix Inc.», 2001-2018, «Bitrix Inc.», 2018