Sharing news and ideas about Bitrix24! Discover all product capabilities
with our Community!

The REST API can be used to import leads to CRM only.

Creating leads in the CRM from external services can be done using the special-purpose page:
"your_name".bitrix24.com/crm/configs/import/lead.php

 For a lead to be added to the CRM you must:

1. Call this page with a GET or POST method
   
2. Pass at least 3 required parameters: login and password of the user who is the creator of the lead, and the title of the lead.
   

The script will return a JSON-object with the parameters code and error_message.

! We recommend using a separate user with access only to add leads and without access to anything else. 
 

Code	Description
400	Parameters missing or parameters invalid
403	Authorization or access error
201	Lead added

Table 2: Parameters

Parameter	Type	Description
LOGIN*	S tring	Login
PASSWORD*	S tring	Password
TITLE*	S tring	Title
COMPANY_TITLE	S tring	Company Name
NAME	S tring	First Name
LAST_NAME	S tring	Last Name
SECOND_NAME	S tring	Second Name
POST	S tring	Position
ADDRESS	S tring	Address
COMMENTS	S tring	Comment
SOURCE_DESCRIPTION	S tring	Source Description
STATUS_DESCRIPTION	S tring	Status Description
OPPORTINUTY	Double	Opportunity
CURRENCY_ID	S tring	Currency
PRODUCT_ID	S tring	Product
SOURCE_ID	S tring	Source
STATUS_ID	S tring	Lead Status
ASSIGNED_BY_ID	Int	Responsible
PHONE_WORK	S tring	Work Phone
PHONE_MOBILE	S tring	Mobile
PHONE_FAX	S tring	Fax
PHONE_HOME	S tring	Home Phone
PHONE_PAGER	S tring	Pager
PHONE_OTHER	S tring	Other Phone
WEB_WORK	S tring	Corporate Site
WEB_HOME	S tring	Personal Site
WEB_FACEBOOK	S tring	Facebook Page
WEB_LIVEJOURNAL	S tring	LiveJournal Page
WEB_TWITTER	S tring	Twitter Account
WEB_OTHER	S tring	Other Site
EMAIL_WORK	S tring	Work E-mail
EMAIL_HOME	S tring	Personal E-mail
EMAIL_OTHER	S tring	Other E-mail
IM_SKYPE	S tring	Skype
IM_ICQ	S tring	ICQ
IM_MSN	S tring	MSN/Live!
IM_JABBER	S tring	Jabber
IM_OTHER	S tring	Other Messenger

*  - required parameter

The  STATUS_ID , SOURCE_ID , CURRENCY_ID, and  PRODUCT_ID parameters are sel ected from a corresponding directory of the CRM.

Below are tables with value sets of these parameters after installation of the module.
Important:  values can be changed by the intranet administrator or deleted.

Table 3: STATUS_ID – Lead Statuses

Value	Description
NEW	Unassigned
ASSIGNED	Responsible Assigned
DETAILS	Waiting for Details
CANNOT_CONTACT	Cannot Contact
IN_PROCESS	In Progress
ON_HOLD	On Hold
RESTORED	Restored
CONVERTED	Converted
JUNK	Junk Lead

Table 4: SOURCE_ID – Sources

Value	Description
SELF	Personal Contact
PARTNER	Existing Client
CALL	Call
WEB	Website
EMAIL	E-Mail
CONFERENCE	Conference
TRADE_SHOW	Show/Exhibition
EMPLOYEE	Employee
COMPANY	Campaign
HR	HR Department
MAIL	E-Mail Message
OTHER	Other

Table 5: CURRENCY_ID – Currencies

Value	Description
USD	US Dollar
EUR	Euro

Table 6: PRODUCT_ID – Products

Value	Description
PRODUCT_1	Bitrix Site Manager
PRODUCT_2	Bitrix Intranet
OTHER	Other

Aside fr om the main fields, a lead may have additional custom fields created by the CRM administrator. They can also be passed to the page.

Only this API is available in the Bitrix24 service.
Do you know about Bitrix Intranet product (the inbox version of Bitrix24)? The extended API can be used there.

Bitrix24 doesn’t support this now, and plans to add support for add-ons are mid-term at earliest. We are going to release our own app (for Android and iOS) this Fall, but its first version won't have all the features (e.g. CRM) that the service does.

A lead name