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 | Description | Type | Note |
---|---|---|---|
ADDRESS | Contact address | string | |
ADDRESS_2 | Second page of the address | string | In some countries it is customary to split an address into 2 parts |
ADDRESS_CITY | City | string | |
ADDRESS_COUNTRY | Country | string | |
ADDRESS_COUNTRY_CODE | Country code | string | |
ADDRESS_POSTAL_CODE | Postal code | string | |
ADDRESS_PROVINCE | Province | string | |
ADDRESS_REGION | Region | string | |
ASSIGNED_BY_ID | Associated with user by ID | user | |
BIRTHDAY | Date of birth | date | |
COMMENTS | Comments | string | |
COMPANY_ID | Linking a contact to a company | crm_company | Read only |
COMPANY_TITLE | Name of company, associated with a lead | crm_company | |
CONTACT_ID | Linking a lead to a contact | crm_contact | Read only |
CREATED_DY_ID | Who created | user | Read only |
DATA_CREATE | Creation date | datetime | Read only |
DATA_MODIFY | Date modified | datetime | Read only |
E-mail address | crm_multifield | Multiple | |
HAS_MAIL | E-mail field fill-up check | char | Read only |
HAS_PHONE | Telephone field fill-up check | char | Read only |
HONORIFIC | Request type | crm_status | |
ID | Contact ID | integer | Read only |
IM | Messengers | crm_multifield | Multiple |
IS_RETURN_CASTOMER | Repeat lead attribute | char | Read only |
MODIFY_BY_ID | Last modification author ID | user | Read only |
MOVED_TIME | Date when item was moved to current stage | user | Read only |
NAME | Name | string | Required |
OPENED | Accessible for all | char | |
ORIGINATOR_ID | Data source ID | string | Used only to link to to an external source. |
ORIGIN_ID | Element ID in the data source | string | Used only to link to to an external source. |
ORIGIN_VERSION | Original version | string | Used 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 telephone | crm_multifield | Multiple |
PHOTO | Contact photo | file | |
POST | Position | string | |
SECOND_NAME | Second name | string | Required |
SOURCE_DESCRIPTION | Source description? | string | |
SOURCE_ID | Source ID | crm_status | Status from directory |
STATUS_DESCRIPTION | string | ||
STATUS_ID | string | ||
STATUS_SEMANTIC_ID | string | ||
TITLE | Lead name | string | Required |
UTM_CAMPAIGN | Advertisement campaign designation | string | |
UTM_CONTENT | Campaign content | string | For example, for context announcements. |
UTM_MEDIUM | Type of traffic | string | CPC (announcements), CPM (banners) |
UTM_SOURCE | Advertisement system | string | Google-Adwords and others. |
UTM_TERM | Campaign search condition | string | For example, contextual advertising keywords. |
WEB | URL for contact resources | crm_multifield | Multiple |
© «Bitrix24», 2001-2023