API - FAQ

Tags:  

1. How many days a ticket is valid?

Ans: Your ticket is valid only for 7 days. After 7 days, you have to generate a new ticket in your application as given below:


2. Is it necessary to get the ticket for each request?

Ans: No. You need not generate new ticket for every request. You can generate the ticket ID once the API call returns the response as "Invalid Ticket Id" and you can call the same API with the newly generated ticket.


3. What is the maximum limit of records can be fetched through getAllRecords API?

Ans: You can fetch a maximum of 200 records per request through getAllRecords method.


4. Whether API key is user-specific or organization-specific?

Ans: Zoho CRM API key is organization-specific. You can use the same API Key for all users with different ticket IDs (user-specifc).


5. Can everyone in the same company use the same API Key?

Ans: Yes, everyone in your organization can use the same API key for development and integration of third-party applications.


6. What is the format of the xmlData parameter for the insertRecords and updateRecords methods?

Ans: Use the following XMLData parameters while using insertRecords/updateRecords methods:

insertRecords: https:// crm.zoho.com/crm/private/xml/Leads/insertRecords?apikey=[API Key]&ticket=[Ticket]

  • ticket=xy4gr112345fgg
  • apikey=sbdjEDBDJ1323
  • xmlData= as given below
<Leads>
<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>
</Leads>

updateRecords: https://crm.zoho.com/crm/private/xml/Leads/updateRecords?apikey=[API Key]&ticket=[Ticket]

  • ticket=xy4gr112345fgg
  • apikey=sbdjEDBDJ1323
  • id = 1000000019001
  • xmlData= as given below

<Leads>
<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>
</Leads>

7. Is it necessary to send all the parameters in POST?

Ans: Yes, you have to send all parameters in POST.


8. What is the format of the xmlData parameter, if i want to associate a task or event to a CRM records (contact/account)?

Ans: Use the following sample XML for relating an event with the account and contact respectively.

Account:

<Events><row no='1'>
<fieldlabel value='SEMODULE'>Accounts</fieldlabel>
<fieldlabel value='SEID'>22222222222</fieldlabel>
<fieldlabel value='Subject'>test</fieldlabel>
<fieldlabel value='Start DateTime'>12/12/2009 11:12 PM</fieldlabel>
<fieldlabel value='End DateTime'>12/12/2009 11:12 PM</fieldlabel>
</row>
</Events>

Contact:

<Events><row no='1'>
<fieldlabel value='SEMODULE'>Contacts</fieldlabel>
<fieldlabel value='CONTACTID'>22222222222</fieldlabel>
<fieldlabel value='Subject'>test</fieldlabel>
<fieldlabel value='Start DateTime'>12/12/2009 11:12 PM</fieldlabel>
<fieldlabel value='End DateTime'>12/12/2009 11:12 PM</fieldlabel>
</row>
</Events>

9. Can I use the Record ID while associating a lookup field with a module?

Ans: Yes, you can use the Record ID while associating lookup field with modules (Ex: Associating campaign with a lead or Account with a Contact).


10. Can I attach documents to the Account using API?

Ans: No, currently you cannot attach documents using Zoho CRM API. We will provide this option in one of the future updates.


11. Can I trigger email after inserting a lead through API?

Ans: No, currently you cannot trigger email to lead after inserting lead through API. We will provide this option in one of the future updates.

12. How do I retrieve single Account using getAllRecords?

Ans: You can retrieve single account using the getRecordById method by passing the id of the record.

13. How to assign new lead to owner when inserting via API?

Ans: When inserting lead via API, make sure you are specifying the email address of the lead owner. If you use the lead owner name or userID, lead will be assigned to the default login credential used in ticket generation.



Related Topics




 RSS of this page


New to Zoho CRM?  Sign up for Free!  or Request a Demo
 
© 2009, Zoho Corp. All rights reserved.