Bitrix24 Community

Bitrix API, Documentation

Piet Brauer User Posts: 1 Joined: 05/24/2012	#1 05/24/2012 18:39:53 Hey, I read on the main page about the API? Is there any documentation or thread for the API?? Cheers, Piet.

Ann Slyshkina

Administrator

Posts: 201 Joined: 04/27/2012

05/25/2012 13:33:25

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:

Call this page with a GET or POST method
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.

Andy Morris User Posts: 5 Joined: 09/14/2012	#3 09/14/2012 09:50:06 Ann, I like more information and documentation on the complete API. Is there a way to do things other than post data. Can I also pull data out using the API? Can you point to a page with that documentation.

Ann Slyshkina Administrator Posts: 201 Joined: 04/27/2012	#4 09/14/2012 15:01:48 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.

Andy Morris User Posts: 2 Joined: 09/14/2012	#5 09/14/2012 15:13:51 ok. so i am a developer and was hoping to create an android app that would look up contextual information for incoming calls. using the bitrix24.com product that is not possible? and is not planned on being possible in the future?

Ann Slyshkina Administrator Posts: 201 Joined: 04/27/2012	#6 09/14/2012 18:16:39 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.

Patrick Barry User Posts: 1 Joined: 12/09/2012	#7 12/09/2012 03:20:19 What needs to go into the TITLE variable?

Ann Slyshkina Administrator Posts: 201 Joined: 04/27/2012	#8 12/13/2012 14:35:38 A lead name

Dan Dascalescu User Posts: 1 Joined: 01/16/2013	#9 02/13/2013 10:21:13 Just wanted to update this thread to mention that mobile apps have been released: http://www.bitrix24.com/features/mobile-and-desktop-apps.php

Anna Yakovleva User Posts: 443 Joined: 09/07/2012	#10 02/14/2013 12:14:20 Thank you, Dan! Yes, we released Bitrix24 mobile version. Now it's available for two platform (IOS and Android). We also going to develop our mobile app and extend its features. You can find Bitrix24 mobile version inApp Store and Google Market

Sónia Liquito User Posts: 3 Joined: 08/26/2013	#11 08/26/2013 15:43:49 Hey, About the REST API of Bitrix24 Service, there still is nothing planned for an update in the future?

Evgeniya Boyko User Posts: 443 Joined: 09/07/2012	#12 08/29/2013 19:15:24 Hi, The REST API has been updated. But documentation for this functionality is not ready yet. We will publish it as soon as possible. regards Evgeniya

Pawel Kochanowski

User

Posts: 1 Joined: 11/22/2013

#13

11/22/2013 22:40:46

Quote

Ann Slyshkina wrote:
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:
Call this page with a GET or POST method
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.

Dear Ann,

I have a problem with send of data from parameter "PRODUCT_ID":

1. Add product "TEST" (ID:30)

2. Add "'PRODUCT_ID' => $leadData['PRODUCT_ID'],"

Code

   // get lead data from the form
   $postData = array(
      'TITLE' => $leadData['TITLE'],
      'EMAIL_HOME' => $leadData['EMAIL_HOME'],
      'NAME' => $leadData['NAME'],
      'LAST_NAME' => $leadData['LAST_NAME'],
      'PHONE_MOBILE' => $leadData['PHONE_MOBILE'],
      'PRODUCT_ID' => $leadData['PRODUCT_ID'],
      'CURRENCY_ID' => $leadData['CURRENCY_ID'],
   );

3. Add form fild

Code
// HTML form <input type="hidden" name="DATA[PRODUCT_ID]" value="30" />

Code
// HTML form <input type="hidden" name="DATA[PRODUCT_ID]" value="TEST" />

All data is stored in new Lead except for the product. What is wrong?

Edited: Pawel Kochanowski - 11/22/2013 22:42:42

Yana Prokopets Administrator Posts: 4246 Joined: 09/20/2013	#14 11/25/2013 14:34:33 Hi Pawel, There is no possibiblity now to connect the lead to the product through REST_API. The "PRODUCT_ID" field - is already an "old" field, and there is no possibility yet to use the new added "PRODUCT_ROWS" field We have informed our Development Department about this issue. Kind Regards, Yana.

Jody LeBlanc User Posts: 1 Joined: 01/30/2014	#15 01/30/2014 18:39:45 It's been a long time coming for the documentation on that API, if it's been updated... What about duplicate leads? If there's a lead posted to the CRM, will the original lead be updated or will a duplicate lead be created?

Yana Prokopets

Administrator

Posts: 4246 Joined: 09/20/2013

#16

01/31/2014 12:50:21

Hi Jody,

Quote
What about duplicate leads? If there's a lead posted to the CRM, will the original lead be updated or will a duplicate lead be created?

As for now - a duplicate lead is created, but the duplicates problem will be solved this spring. Stay tuned for upcoming Bitrix24 spring release.

Quote
It's been a long time coming for the documentation on that API, if it's been updated...

If you are talking about Rest API documentation for Bitrix24 cloud service - we expect it at the end of February.

Kind Regards,

Yana.

Team Administrator

User

Posts: 1 Joined: 08/15/2014

#17

08/15/2014 18:35:15

Two Annotations:

If you are using user defined fields, you can only import data if you used the internal field name. Unfortunately its not displayed anywhere , not even in an error message if the field was set as required (Bitrix team could you change that). But when you open the field editing form you will find the internal field name in the url.
Example: url: xyz.bitrix24.com/crm/configs/fields/CRM_LEAD/edit/UF_CRM_1234567890/ where UF_CRM_1234567890 is the internal field name.
Don't just copy the link provided by Slyshkina ("your_name".bitrix24.com/crm/configs/import/lead.php) if your bitrix24 instance doesn't run on a .com platform. If your instance for example runs on a .de platform, just replace .com by .de

Regards

Uwe

Yana Prokopets Administrator Posts: 4246 Joined: 09/20/2013	#18 08/18/2014 14:15:50 Thanks for your tips Uwe!

Sajid Javed User Posts: 3 Joined: 09/23/2014	#19 09/23/2014 22:59:28 Hi EveryOne I have problem to import leads using api and receiving the following response [body] => {'error':'400','error_message':'The required field Industry is missing.The required field SIC Code is missing.','AUTH':'b3ea1da918e59577473bf9e0d99c21e7'} Can anyone guide me what is this SIC Code Thanks in Advance Sajid Javed

Sajid Javed

User

Posts: 3 Joined: 09/23/2014

#20

09/24/2014 14:17:38

Quote
Yana Prokopets wrote: Hi I have problem to import leads using api and receiving the following response [body] => {'error':'400','error_message':'The required field Industry is missing.The required field SIC Code is missing.','AUTH':'b3ea1da918e59577473bf9e0d99c21e7'} Can anyone guide me what is this SIC Code Thanks in Advance Sajid Javed

Hi Please help in this issue thanks

Edited: Sajid Javed - 09/24/2014 14:18:16

Ann Slyshkina Administrator Posts: 201 Joined: 04/27/2012	#21 09/25/2014 12:29:41 Hello Sajid, It seems that the SIC is a system for classifying industries by a four-digit code. But there is no such field for any entity in the Bitrix24 CRM. Is this field a custom field for leads in your CRM? If you still have any questions, please contact our Helpdesk.

Sajid Javed User Posts: 3 Joined: 09/23/2014	#22 09/25/2014 12:34:51 Hi Ann Slyshkina This is not a custom field in our CRM we are using default fields Please check this link http://scanchex.net/rest.php

Ann Slyshkina Administrator Posts: 201 Joined: 04/27/2012	#23 09/25/2014 12:50:14 The issue should be investigated via the Helpdesk. Could you please create a ticket here?

Brandon Pearce User Posts: 2 Joined: 11/03/2014	#24 11/03/2014 02:48:59 Is it possible to sync the leads list through the API? For example, automatically adding leads to it through the API when they appear our internal database. And when leads are updated in Bitrix24, is it possible to send the changes back to our company database?

Yana Prokopets Administrator Posts: 4246 Joined: 09/20/2013	#25 11/05/2014 15:02:01 Hi Brandon! The method described above allows to add leads only- there is no automation there. If you is able to orginize automatic data transmission in the required fromat to this page "your_name".bitrix24.com/crm/configs/import/lead.php" - then you'll get the automation, Kind Regards, Yana.

Mohammad Ariff User Posts: 1 Joined: 10/07/2015	#26 10/07/2015 09:05:33 Is it possible can we get multiple attachment form out side forms to bitrix leads in self hosted site.

Yana Prokopets Administrator Posts: 4246 Joined: 09/20/2013	#27 10/07/2015 16:09:44 Hi Mohammad! Please refer to this API helpfor the self-hosted version. Best, Yana.

XTAS Technologies User Posts: 1 Joined: 02/18/2016	#28 02/18/2016 11:22:23 Hey, I'm having a problem to import info from a web form. when i register from localhost (127.0.0.1/) then i get the info but when same thing i did from my website(domain.in) then it doesn't give any info name.bitrix24.com/crm/lead/. What is the reason ??? Please help !!!

VINAY HUNNUMAN User Posts: 1 Joined: 08/26/2016	#29 08/26/2016 14:33:10 Hi...I want to the use the REST API. I cannot find this page:("your_name".bitrix24.com/crm/configs/import/lead.php). Encoutering error 404. Your help would be much appreciated.

Yana Prokopets Administrator Posts: 4246 Joined: 09/20/2013	#30 09/05/2016 15:17:03 Hi guys! Please contact our Helpdesk directly with details. Thank you. Best, Yana.

Dan Tilley User Posts: 23 Joined: 08/27/2014	#31 09/07/2016 08:19:18 Hi, Is the workgroup lists function exposed in the API?

B24_14423913

User

Posts: 1 Joined: 09/04/2017

#32

09/04/2017 00:35:28

I'm doing a trial and Bitrix24 (free account) won't accept my MailChimp API and gives an error message:

ERROR_CORE: Name is not specified.
(400)

In addition, I can not get any other app to integrate. I receive the following messages:

The webpage at https://yammer.crealink.ru/?DOMAIN=naptownmusic.bitrix24.com&PROTOCOL=1&LANG=en&... be temporarily down or it may have moved permanently to a new web address.

The webpage at https://card.b24.tools/oauth/get_token_iframe?DOMAIN=naptownmusic.bitrix24.com&PROTOCOL=1&am... be temporarily down or it may have moved permanently to a new web address.

I have gone to the Applications tab > My Apps and authorized my access permissions and still get these error codes and messages.

Thanks.

Nick Obydennov

Administrator

Posts: 71 Joined: 07/10/2017

#33

09/08/2017 20:14:50

Quote
B24_14423913 wrote: my MailChimp API and gives an error message: ERROR_CORE: Name is not specified. (400)

Hello! Please, contact our HelpDesk with this query. Thank you!

Regards,

Nick

Nick Obydennov

Administrator

Posts: 71 Joined: 07/10/2017

#34

09/08/2017 20:20:19

Quote
Dan Tilley wrote: Is the workgroup lists function exposed in the API?

Hi! At the moment, specific documentation is not yet available.

4,000,000+

organizations
are already using Bitrix24