Zoho CRM API

What should be the XML format for inserting records?

Can you fetch records based on certain criteria such as last modified date?

I tried using correct api Key and loginName, but always getting same error, here is what I am doing:

http://crm.zoho.com/crm/private/xml/Accounts/getAllRecords?loginName=<the-login-name>&apikey=<the-api-key>&fromIndex=1&toIndex=20&sortColumnString=Account Name&sortOrderString=sort_desc

I am getting following response all the time...for any kind of request. Can I know what is meaning of code 4500? Is there any list of such error codes?

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/crm/private/xml/Accounts/getAllRecords">
<error>
<code>4500</code>
<message>Internal Server Error while processing this request</message>
</error>
</response>

Thanks
Sameer

Where can i see the reponse format of these APIs.

Dear Guest,

What should be the XML format for inserting records?

The XML format for inserting record should be same as what we give in our fetching of records.

Dear Sameer,

API has been working for many users. Do you have this problem with any other methods ?

My guess would be you must have used your apikey with <, > symbols. Use without these symbols. Just let us know to support@zohocrm.com if you still have problem.

It would be helpful if instructions on how to obtain a ZohoCRM API key were published on this page. Due to the lack of documentation, one would assume that keys used for other Zoho areas would work here. It appears that other people are making the same mistake that I did by using the wrong API key rather than by using <> symbols.

Hi...

We use Zoho CRM since last few months.

We badly need the API.

Is the current version stable?

Where is the detailed documentation of the API?

what should be the xml format to make an request for the data from zoho CRM ? can any one provide the sample of it ?

Hi all ...

Can any one provide a sample of XML for making an

request for data from ZOHO CRM.

How can one get the api key with the help of UserName and password ?

I dont undertand this api.
"The XML format for inserting record should be same as what we give in our fetching of records."
But the return in your fetch method,s is Json.What xml? I has trying but is impossible know it.

Other issue:The entitys return a object if there are a 1 record and a collection when there are 2 or more records.This is a error because I dont know how records i have in the database.I explain:
In contacts for example, if you have a only one record you get
result.Contacts.row. collection of fieldlabel
But if you have 2 records you get
result.Contacts.collection of row. collection of fieldlabel

The first case is a error in my opinion,if you have a only one record in the database you should get
result.Contacts.collection of row with only one element. collection of fieldlabel

The api,s should be documented.A lot of examples and code is necessary in this code.

You understand me? sorry for my English.

I agree.

I think this API should be very usefull for many small or medium corporations.

Structure, type, format, almost nothing of the insertRecords method are documented, for example.

Please Zoho, well-document this API !

Hi,

Sorry for the late response and my sincere apologize for the poor documentation. We are working on it. It will have some basic information about our API in a week's time.

For inserting the records, you support only XML format. That format should be same as that fetching records in XML format. For fetching we support json or xml and for inserting we support only XML as of now. Hence XML format should be given for inserting records.

Dear Oscar,

We will give in a collection of rows irrespective of the no. of rows.


Thank you,

With Best Regards,
Dilip,
Zoho CRM.

So,can you tell me about this difference?
This is the same query,with one and with two records in a test account:

With one record:
{"response":{"uri":"/crm/private/json/Contacts/getAllRecords","result":{"Contacts":{"row":{"fieldlabel":[{"value":"CONTACTID","content":"25735000000025037"},{"value":"Contact Owner","content":"profesional"},{"value":"Lead Source","content":"Cold Call"},{"value":"First Name","content":"prueba 1"},{"value":"Last Name","content":"apellidos"},{"value":"Account Name","content":"trhhtrhtr"},{"value":"Vendor Name","content":"null"},{"value":"Email","content":"xx@www.com"},{"value":"Title","content":"null"},{"value":"Department","content":"null"},{"value":"Phone","content":"null"},{"value":"Home Phone","content":"null"},{"value":"Other Phone","content":"null"},{"value":"Fax","content":"null"},{"value":"Mobile","content":"null"},{"value":"Date of Birth","content":"null"},{"value":"Assistant","content":"null"},{"value":"Asst Phone","content":"null"},{"value":"Reports To","content":"null"},{"value":"Created By","content":"profesional"},{"value":"Modified By","content":"profesional"},{"value":"Created Time","content":"2007-08-22 15:51:02"},{"value":"Modified Time","content":"2008-04-26 12:04:40"},{"value":"Common Status","content":"created_modified_viewed"},{"value":"Mailing Street","content":"null"},{"value":"Other Street","content":"null"},{"value":"Mailing City","content":"null"},{"value":"Other City","content":"null"},{"value":"Mailing State","content":"null"},{"value":"Other State","content":"null"},{"value":"Mailing Zip","content":"null"},{"value":"Other Zip","content":"null"},{"value":"Mailing Country","content":"null"},{"value":"Other Country","content":"null"},{"value":"Description","content":"null"},{"value":"Email Opt Out","content":"false"},{"value":"Skype ID","content":"null"},{"value":"Campaign Source","content":"null"},{"value":"Salutation"}],"no":"1"}}}}}

Yo note ""Contacts":{"row":{"fieldlabel":[{"value":"

And now with 2 recods:

{"response":{"uri":"/crm/private/json/Contacts/getAllRecords","result":{"Contacts":{"row":[{"fieldlabel":[{"value":"CONTACTID","content":"25735000000041003"},{"value":"Contact Owner","content":"profesional"},{"value":"Lead Source","content":"null"},{"value":"First Name","content":"contacto 1"},{"value":"Last Name","content":"apellido"},{"value":"Account Name","content":"null"},{"value":"Vendor Name","content":"null"},{"value":"Email","content":"null"},{"value":"Title","content":"null"},{"value":"Department","content":"null"},{"value":"Phone","content":"null"},{"value":"Home Phone","content":"null"},{"value":"Other Phone","content":"null"},{"value":"Fax","content":"null"},{"value":"Mobile","content":"null"},{"value":"Date of Birth","content":"null"},{"value":"Assistant","content":"null"},{"value":"Asst Phone","content":"null"},{"value":"Reports To","content":"null"},{"value":"Created By","content":"profesional"},{"value":"Modified By","content":"profesional"},{"value":"Created Time","content":"2008-05-02 12:44:37"},{"value":"Modified Time","content":"2008-05-02 12:44:37"},{"value":"Common Status","content":"created_viewed"},{"value":"Mailing Street","content":"564654"},{"value":"Other Street","content":"null"},{"value":"Mailing City","content":"null"},{"value":"Other City","content":"null"},{"value":"Mailing State","content":"null"},{"value":"Other State","content":"null"},{"value":"Mailing Zip","content":"null"},{"value":"Other Zip","content":"null"},{"value":"Mailing Country","content":"null"},{"value":"Other Country","content":"null"},{"value":"Description","content":"null"},{"value":"Email Opt Out","content":"false"},{"value":"Skype ID","content":"null"},{"value":"Campaign Source","content":"null"},{"value":"Salutation"}],"no":"1"},{"fieldlabel":[{"value":"CONTACTID","content":"25735000000025037"},{"value":"Contact Owner","content":"profesional"},{"value":"Lead Source","content":"Cold Call"},{"value":"First Name","content":"prueba 1"},{"value":"Last Name","content":"apellidos"},{"value":"Account Name","content":"trhhtrhtr"},{"value":"Vendor Name","content":"null"},{"value":"Email","content":"xx@www.com"},{"value":"Title","content":"null"},{"value":"Department","content":"null"},{"value":"Phone","content":"null"},{"value":"Home Phone","content":"null"},{"value":"Other Phone","content":"null"},{"value":"Fax","content":"null"},{"value":"Mobile","content":"null"},{"value":"Date of Birth","content":"null"},{"value":"Assistant","content":"null"},{"value":"Asst Phone","content":"null"},{"value":"Reports To","content":"null"},{"value":"Created By","content":"profesional"},{"value":"Modified By","content":"profesional"},{"value":"Created Time","content":"2007-08-22 15:51:02"},{"value":"Modified Time","content":"2008-04-26 12:04:40"},{"value":"Common Status","content":"created_modified_viewed"},{"value":"Mailing Street","content":"null"},{"value":"Other Street","content":"null"},{"value":"Mailing City","content":"null"},{"value":"Other City","content":"null"},{"value":"Mailing State","content":"null"},{"value":"Other State","content":"null"},{"value":"Mailing Zip","content":"null"},{"value":"Other Zip","content":"null"},{"value":"Mailing Country","content":"null"},{"value":"Other Country","content":"null"},{"value":"Description","content":"null"},{"value":"Email Opt Out","content":"false"},{"value":"Skype ID","content":"null"},{"value":"Campaign Source","content":"null"},{"value":"Salutation"}],"no":"2"}]}}}}

Now,the return is ""Contacts":{"row":[{"fieldlabel":[{"value":"

The diference is that first query need a "[" between "row" and "fieldlabel".In the second query is well.


Do you understand me?

Only one example please.
I call the insert record with this xml:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/crm/private/xml/Contacts/insertRecords"><result><Contacts><row no="1"><fieldlabel value="CONTACTID">25735000000041003</fieldlabel><fieldlabel value="Contact Owner">profesional</fieldlabel><fieldlabel value="Lead Source">null</fieldlabel><fieldlabel value="First Name">contacto 1</fieldlabel><fieldlabel value="Last Name">apellido</fieldlabel><fieldlabel value="Account Name">null</fieldlabel><fieldlabel value="Vendor Name">null</fieldlabel><fieldlabel value="Email">null</fieldlabel><fieldlabel value="Title">null</fieldlabel><fieldlabel value="Department">null</fieldlabel><fieldlabel value="Phone">null</fieldlabel><fieldlabel value="Home Phone">null</fieldlabel><fieldlabel value="Other Phone">null</fieldlabel><fieldlabel value="Fax">null</fieldlabel><fieldlabel value="Mobile">null</fieldlabel><fieldlabel value="Date of Birth">null</fieldlabel><fieldlabel value="Assistant">null</fieldlabel><fieldlabel value="Asst Phone">null</fieldlabel><fieldlabel value="Reports To">null</fieldlabel><fieldlabel value="Created By">profesional</fieldlabel><fieldlabel value="Modified By">profesional</fieldlabel><fieldlabel value="Created Time">2008-05-02 12:44:37</fieldlabel><fieldlabel value="Modified Time">2008-05-02 12:44:37</fieldlabel><fieldlabel value="Common Status">created_viewed</fieldlabel><fieldlabel value="Mailing Street">564654</fieldlabel><fieldlabel value="Other Street">null</fieldlabel><fieldlabel value="Mailing City">null</fieldlabel><fieldlabel value="Other City">null</fieldlabel><fieldlabel value="Mailing State">null</fieldlabel><fieldlabel value="Other State">null</fieldlabel><fieldlabel value="Mailing Zip">null</fieldlabel><fieldlabel value="Other Zip">null</fieldlabel><fieldlabel value="Mailing Country">null</fieldlabel><fieldlabel value="Other Country">null</fieldlabel><fieldlabel value="Description">null</fieldlabel><fieldlabel value="Email Opt Out">false</fieldlabel><fieldlabel value="Skype ID">null</fieldlabel><fieldlabel value="Campaign Source">null</fieldlabel><fieldlabel value="Salutation"></fieldlabel></row></Contacts></result></response>

I want only add or modify a record.I try eliminate
"<?xml version="1.0" encoding="UTF-8" ?>"

I try eliminate
<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/crm/private/xml/Contacts/insertRecords">

I try eliminate
<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/crm/private/xml/Contacts/insertRecords"><result>

etc etc,but always I get the same error,4832 bad....

Can you give me a only xml example of format for insert records? is one minute,I dont have a week!!

Other question,with this api is possible modify records?

Thanks.

i am able to fetch the records of different categories, with out mentioning an xml format in the request.

I am interested to know what should be the XML format to insert an record ?

can any one please show me the sample XML format for inserting a record..

waiting for reply....

Regards : Pankaj
pankajlole@cdnsol.com

Dear Oscar,

I got your point. We are just using the API for json to convert from xml to json object and it fetches this. We will fix this as early as possible. Thank you for pointing this out.

Dear Pankaj,

Do not straight away put the xml you got from your fetch query. It contains your primary key Contact ID, modified by, modified time, etc., Only the format should be followed. Hence when you are trying to insert, just keep the required fields ( including the mandatory fields ) and do the insert.

Sample XML for a simple insert into Contact Module is :

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/crm/private/xml/Contacts/insertRecords">
<result>
<Contacts>
<row no="1">
<fieldlabel value="Lead Source">Web Download</fieldlabel>
<fieldlabel value="First Name">contacto 1</fieldlabel>
<fieldlabel value="Last Name">apellido</fieldlabel>
<fieldlabel value="Email">testing@testing.com</fieldlabel>
<fieldlabel value="Title">Manager</fieldlabel>
<fieldlabel value="Phone">1234567890</fieldlabel>
<fieldlabel value="Home Phone">0987654321</fieldlabel>
<fieldlabel value="Other Phone">1212211212</fieldlabel>
<fieldlabel value="Fax">02927272626</fieldlabel>
<fieldlabel value="Mobile">292827622</fieldlabel>
</row>
</Contacts>
</result>
</response>


Sorry for the late response and please revert if you have still have any problem in inserting the data.

Thank you,

With Best Regards,
Dilip,
Zoho CRM.

Sorry but this not work for me.I try with it,what is the error? the response from server alwais is code 4832..

http://crm.zoho.com/crm/private/xml/Contacts/insertRecords?loginName=xxxxxxx&apikey=xxxxxxx&xml=<?xml version="1.0" encoding="UTF-8"?><response uri="/crm/private/xml/Contacts/insertRecords"><result><Contacts><row no="22"><fieldlabel value="Lead Source">Web Download</fieldlabel><fieldlabel value="First Name">contacto 1</fieldlabel><fieldlabel value="Last Name">apellido</fieldlabel><fieldlabel value="Email">testing@testing.com</fieldlabel><fieldlabel value="Title">Manager</fieldlabel><fieldlabel value="Phone">1234567890</fieldlabel><fieldlabel value="Home Phone">0987654321</fieldlabel><fieldlabel value="Other Phone">1212211212</fieldlabel><fieldlabel value="Fax">02927272626</fieldlabel><fieldlabel value="Mobile">292827622</fieldlabel></row></Contacts></result></response>

Sorry,but is very difficult work in this way.Responses in 4,6 or 10 days is very bad support.
If you dont have a team that can support the new features,you dont publish it because lost your time and time from all customers.

Same for me : your post example looks like a result and not a post message

Dear Oscar,

The parameter name should be xmlData instead of xml for passing your xml content. Hence the problem.

I apologize for the frustration caused because of our lousier response. We will do it in a much faster way.

Please revert to us for further clarifications.

Thank you,

With Best Regards,
Dilip,
Zoho CRM.

Hi,

When I fetch the salesorder data, it seems that the products info is Null. Is there any way to get the list of product id/info in the salesorder?

thanks

xmlData works better :-)
Thank you

When I fetch the salesorder data, it seems that the products info is Null. Is there any way to get the list of product id/info in the salesorder?

Currently, you can't get the Product Information while fetching the Sales Order data. We will definitely provide the support for getting the product info in our future updates.

Kindly bear with us.

Regards,
Mahesh,
(Zoho CRM Team).

Can we use the API to insert emails, notes, products, etc for leads?

"The parameter name should be xmlData instead of xml for passing your xml content. Hence the problem. "

It'd be really helpful if you'd post a full string.

With this api is possible modify records or only insert ?

Can we use the API to insert emails, notes, products, etc for leads?

Currently, this support is not available. We will definitely provide the option for inserting emails, notes etc in our forth coming updates. Kindly bear with us.

Regards,
Mahesh,
(Zoho CRM Team).

It'd be really helpful if you'd post a full string.

I am not able to understand your comment clearly. Are you telling about the detailed API document of the insert records. If so, then we are already working on it. It will be available soon.

Or you need an example about inserting the records, ie., how the xml format looks?

Kindly correct me, if my understanding was wrong.

Regards,
Mahesh,
(Zoho CRM Team).

With this api is possible modify records or only insert ?

Another question,How can I insert invoicesLines in Invoices? the xml that you response don have invoicelines collection.Can you put a example of insert invoice please? thanks.

<?xml version="1.0" encoding="UTF-8"?>
<response uri="/crm/private/xml/Invoices/getAllRecords">
<result>
<Invoices>
<row no="1">
<fieldlabel value="INVOICEID">25735000000038009</fieldlabel>
<fieldlabel value="Subject"><![CDATA[Factura de pedido]]></fieldlabel>
<fieldlabel value="SALESORDERID">null</fieldlabel>
<fieldlabel value="Sales Order"><![CDATA[null]]></fieldlabel>
<fieldlabel value="Purchase Order"><![CDATA[null]]></fieldlabel>
<fieldlabel value="Due Date"><![CDATA[2008-04-29]]></fieldlabel>
<fieldlabel value="Excise Duty"><![CDATA[0.0]]></fieldlabel>
<fieldlabel value="Sales Commission"><![CDATA[0.0]]></fieldlabel>
<fieldlabel value="Status"><![CDATA[Created]]></fieldlabel>
<fieldlabel value="ACCOUNTID">25735000000035011</fieldlabel>
<fieldlabel value="Account Name"><![CDATA[aaasadsa]]></fieldlabel>
<fieldlabel value="SMOWNERID">25735000000025001</fieldlabel>
<fieldlabel value="Invoice Owner"><![CDATA[profesional]]></fieldlabel>
<fieldlabel value="SMCREATORID">25735000000025001</fieldlabel>
<fieldlabel value="Created By"><![CDATA[profesional]]></fieldlabel>
<fieldlabel value="MODIFIEDBY">25735000000025001</fieldlabel>
<fieldlabel value="Modified By"><![CDATA[profesional]]></fieldlabel>
<fieldlabel value="Created Time"><![CDATA[2008-04-29 13:13:53]]></fieldlabel>
<fieldlabel value="Modified Time"><![CDATA[2008-04-29 13:14:51]]></fieldlabel>
<fieldlabel value="Sub Total"><![CDATA[377.0]]></fieldlabel>
<fieldlabel value="Tax"><![CDATA[60.32]]></fieldlabel>
<fieldlabel value="Adjustment"><![CDATA[0.0]]></fieldlabel>
<fieldlabel value="Grand Total"><![CDATA[437.32]]></fieldlabel>
<fieldlabel value="Common Status"><![CDATA[created_modified_viewed]]></fieldlabel>
<fieldlabel value="Billing Street"><![CDATA[rue de la sarra n13]]></fieldlabel>
<fieldlabel value="Shipping Street"><![CDATA[null]]></fieldlabel>
<fieldlabel value="Billing City"><![CDATA[la corua]]></fieldlabel>
<fieldlabel value="Shipping City"><![CDATA[null]]></fieldlabel>
<fieldlabel value="Billing State"><![CDATA[la corua]]></fieldlabel>
<fieldlabel value="Shipping State"><![CDATA[null]]></fieldlabel>
<fieldlabel value="Billing Code"><![CDATA[15007]]></fieldlabel>
<fieldlabel value="Shipping Code"><![CDATA[null]]></fieldlabel>
<fieldlabel value="Billing Country"><![CDATA[null]]></fieldlabel>
<fieldlabel value="Shipping Country"><![CDATA[null]]></fieldlabel>
<fieldlabel value="Product Details"><![CDATA[null]]></fieldlabel>
<fieldlabel value="Terms and Conditions"><![CDATA[A pagar en cuenta corriente]]></fieldlabel>
<fieldlabel value="Description"><![CDATA[null]]></fieldlabel>
<fieldlabel value="CONTACTID">null</fieldlabel>
<fieldlabel value="Contact Name"><![CDATA[null]]></fieldlabel>
<fieldlabel value="Discount"><![CDATA[0.0]]></fieldlabel>
<fieldlabel value="Numero de factura"><![CDATA[27]]></fieldlabel>
</row>
</Invoices>
</result>
</response>

Dear Oscar,

We have done the API for modifying records in our local setup. We will let you know once it is updated in the site.

Regarding the invoice line items, currently insert option is not available for inventory modules ie., Quotes , Invoices etc, since we are not supporting the line items. We are working on it. We will let you know once it is done.

Regards,
Mahesh,
(Zoho CRM Team).

Hi,

I failed to insert Contact record,the response from server always is code 4832..The request URI:

http://crm.zoho.com/crm/private/xml/Contacts/insertRecords?loginName=*****&apikey=******&xmlData=<?xml version="1.0" encoding="UTF-8" ?>

<response uri="/crm/private/xml/Contacts/insertRecords">

<result>

<Contacts>

<row no="1">

<fieldlabel value="Lead Source">Web Download</fieldlabel>

<fieldlabel value="First Name">contacto 1</fieldlabel>

<fieldlabel value="Last Name">apellido</fieldlabel>

<fieldlabel value="Email">testing@testing.com</fieldlabel>

<fieldlabel value="Title">Manager</fieldlabel>

<fieldlabel value="Phone">1234567890</fieldlabel>

<fieldlabel value="Home Phone">0987654321</fieldlabel>

<fieldlabel value="Other Phone">1212211212</fieldlabel>

<fieldlabel value="Fax">02927272626</fieldlabel>

<fieldlabel value="Mobile">292827622</fieldlabel>

</row>

</Contacts>

</result>

</response>



and the response is always:

<?xml version=\"1.0\" encoding=\"UTF-8\" ?>

<response uri=\"/crm/private/xml/Contacts/insertRecords\">

<error><code>4832</code>

<message>Problem occured while processing the request</message>

</error></response>


What's the problem?


Thanks

"I failed to insert Contact record,the response from server always is code 4832.."

Sorry about that. Could you please send us your login name (ie., email address which you will use to login into Zoho CRM) to support@zohocrm.com, so that we can check with our exception logs and solve your problem.

Regards,
Mahesh,
(Zoho CRM Team).

I am checking on using Zoho APIs for submitting a case from our application. Well I read this document and understood everything except security.


If I am using Ajax implementation to post an xml file or to getrecords, isn't it true that I am exposing the API key in the js file or any other file. A smart client/programmer can pretty easily check the Temp. internet files and get the API key. After that it's pretty much open, anyone can do anything with that key.


I understand, if I do it through server side, it will be secure. But how would I do this SECURELY through client side posting specially through AJAX?

Hi,

You have to do that from the server side only. If you want to do it from the client side, then you have to encrypt the API key and use it.

Regards,
Mahesh,
(Zoho CRM Team).

you were supposed to introduce an API which will authenticate the user name and password of the user and in reply it will generate the API key already requested by the user earlier.... still waiting for such API to get launch... if you have any updated on this please reply me.....

Thanks & Regards
Pankaj

Dear Pankaj,

As of now, we don't have any API method which will authenticate the user name and password and return the API key. Also, i think we don't make any promises to any customer to give this API method. If so, could you please let us know where we have made that promise, so that we can analyze regarding this and try to implement that in our future updates.

Regards,
Mahesh,
(Zoho CRM Team).

Your insert api is working fine, but i have one query regarding it, can u provide the details of the information like record id, created time etc., in response XML, once user insert the record, because that would be helpful for future operations in that inserted record..... waiting for your reply..
and about the login api authentication, i made a query that can u have any plans to launch such api, because that would be really beneficial for a lot of Zoho CRM api users....

Thanks & Regards
Pankaj,

Hi,

We have to analyze regarding your first requirement and let you know the status.

Regarding your second requirement, we will definitely try to implement this in our future releases. Kindly bear with us.

Regards,
Mahesh,
(Zoho CRM Team).

this is how its done
<form action="http://crm.zoho.com/crm/private/xml/Leads/insertRecords" method="POST">
<input name="loginName" type="text" id="loginName" />
<br />
<input name="apikey" type="text" id="apikey" />
<br />
<textarea name="xmlData" cols="100" rows="10" id="xmlData"></textarea>
<br />
<input type="submit" name="button" id="button" value="Submit" />
</form>

Hi,
Would it be possible to retrieve an invoice as a PDF (as for Writer),
or else a link to this file if it exists?

Thanks.

Dear Didier,

I am not able to get your query clearly. Do you need an API method that will generate the PDF, once you executed that url in the browser? Kindly let us know.

Regards,
Mahesh,
(Zoho CRM Team)