FAQs: Developer Hub
How can I fetch the data from the Leads module to my application using an API?
You can use the Zoho CRM REST API to retrieve data from the Leads module and other modules. Refer to this document for more details.
Is the API key user-specific or organization-specific?
The Zoho CRM API key is organization-specific. You can use the same API Key for all users with different ticket IDs (user-specific).
What is the format of the xmlData parameter to associate a task or event to CRM records?
Use the following sample XML for relating an event with the account and contact respectively.
Account
<Events><row
no="1">
<FL val="SEMODULE">Accounts</FL>
<FL val="SEID">22222222222</FL>
<FL val="Subject">test</FL>
<FL val="Start DateTime">12/12/2009
11:12:25</FL>
<FL val="End
DateTime">12/12/2009 11:12:25</FL>
</row>
</Events>
<Events><row
no="1">
<FL val="SEMODULE">Accounts</FL>
<FL val="SEID">22222222222</FL>
<FL val="Subject">test</FL>
<FL val="Start DateTime">12/12/2009
11:12:25</FL>
<FL val="End
DateTime">12/12/2009 11:12:25</FL>
</row>
</Events>
<Events><row
no="1&">
<FL val="SEMODULE">Contacts</FL>
<FL val="CONTACTID">22222222222</FL>
<FL val="Subject">test</FL>
<FL val="Start DateTime">12/12/2009
11:12:25</FL>
<FL val="End
DateTime">12/12/2009 11:12:25</FL>
</row>
</Events>
Can I trigger an email after inserting a lead through API?
Yes, you can do this by creating a workflow to send automated emails when leads come into CRM. When you call the API to insert Leads, please append the parameter "wfTrigger" with the value as "true". Read more about inserting record parameters.
This will trigger the workflow after the record is inserted, which will in turn send the email.
How do I retrieve a single Account using getAllRecords?
You can retrieve a single account using the getRecordById method by passing the ID of the record.How to assign a new lead to an owner while inserting the lead via API?
While inserting a lead via API, make sure you are specifying the email address of the lead owner. If you use the lead owner's name or user ID, the lead will be assigned to the default login credential used in ticket generation.
If I am using the Enterprise Edition, and I have subscribed for 2 additional users, how many API requests can I make per day?
In Zoho CRM, a single Enterprise Edition user can make a maximum of 25,000 requests per day per organization or 500 users per user license, whichever is lower.
The minimum and maximum limits vary according to the edition which the organization is currently using.
The minimum and maximum limits vary according to the edition which the organization is currently using.
Is it possible to upload and associate an attachment with a record through Zoho CRM API?
Yes. It is possible to associate an attachment with a record through the Zoho CRM API, using the uploadFile method to attach files to records.
What happens if I do not specify a value for the newFormat parameter while fetching records?
The default value of "1" will be assigned to the newFormat parameter, if it is not specified while fetching records, i.e newFormat = 1.
Is it possible to insert records via HTTP post?
No. The records can only be inserted via XML post. For details, refer to this link.For the updateRecords method, where can I get the value for record ID?
The value for the unique record ID will be available in the XML response obtained after inserting or fetching the records.
For Example: <FL val="Id">508020000016189251</FL
What is CRM Authentication Token?
The CRM Authentication Token is an encrypted alphanumeric string required to authenticate your Zoho CRM credentials. It is used to integrate your CRM account with third-party software and services.
Related Links:
Can I generate a new Authentication Token?
Yes. There are two ways by which you can generate a new Authentication Token.
1. The first method is the API mode. You can use the same URL format that you used to generate the existing one. The URL Format is:
2. The second method is the Browser mode. To use this,
- Click Setup > Developer Hub > APIs & SDKs
- In the CRM API page, click Settings and select Authentication Token Generation. Click on the Generate button to get the Authentication Token instantly.
Please note that the existing Authentication Token will also be valid.
How do I delete an existing Authentication Token?
- Log in to accounts.zoho.com.
- Click My Profile Info.
- Go to Sessions and click Active Authtokens.
- All Auth Tokens generated will be listed here.
- Select the checkbox(es) of the Auth Tokens you want to delete and click Remove Selected. The Auth Token will be deleted.
For more information on the Auth Token, click here.
See also
I am inserting a lead using the insertRecords method, but the associated Workflow rule is not triggered. Why?
For the Workflow Rule to be triggered, you need to assign the value true to the wfTrigger parameter. By default, this parameter will be set to false.
What will happen if my API limit has been exceeded for the day?
If your API limit has been exceeded for the day, Zoho CRM will not respond to the API calls for the rest of the day. You need to wait till the API limit is reset for the next day. API limits are reset everyday between 12 am and 3 am PST.If the present API limit does not meet your business requirement, you can increase the API limit/day. To know more about the pricing details to increase the API call limits, please send an email to support@zohocrm.com
To optimize your API usage, get a maximum of 200 records with each request and insert, update or delete a maximum of 100 records with each request.
Note: In all the Zoho CRM Editions, the getSearchRecords & getCVRecords methods have a standard limit of 250 API calls/day.
Can I increase the API limit?
Yes. If the present API limit does not meet your business requirements, you can increase your API limit/day. All you need to do is send us an email to support@zohocrm.com with your requirements and we will get back to you with the pricing details to increase the API call limits.Is it possible to use the getRelatedRecords method for custom lookup fields?
No, you cannot use the getRelatedRecords method for custom lookup fields. It is possible to use this method to fetch related records for the system defined items. For example: You can get the Tasks/Events/Calls related to an Account, Contact, etc.
Yes, everyone in your company can use the same API key for development and integration of third-party applications.
What is the format of the xmlData parameter for the insertRecords and updateRecords methods?
Use the following XMLData parameters while using insertRecords and updateRecords methods:
insertRecords: https:// crm.zoho.com/crm/private/ xml / Leads /insertRecords?apikey= API Key &ticket= Ticket
- ticket=xxxxxxxxxxxxxx
- apikey=xxxxxxxxxxxxxx
- xmlData= as given below
- <Leads>
<row no="1">
< FL val ="Lead Source">Web Download</FL>
< FL val ="First Name">contacto 1</FL>
< FL val ="Last Name">apellido</FL>
< FL val ="Email"> testing@testing.com < /FL >
< FL val ="Title">Manager</FL>
< FL val ="Phone">1234567890</FL>
< FL val ="Home Phone">0987654321</FL>
< FL val ="Other Phone">1212211212</FL>
< FL val ="Fax">02927272626</FL>
< FL val ="Mobile">292827622</FL>
</row>
</Leads>
updateRecords: https://crm.zoho.com/crm/private/xml/Leads/updateRecords?apikey=API Key&ticket=Ticket
- ticket=xxxxxxxxxxxxxxx
- apikey=xxxxxxxxxxxxxxx
- id = 1000000019001
- xmlData= as given below
- <Leads>
<row no="1">
<FL val="Lead Source">Web Download</FL>
<FL val="First Name">contacto 1</FL>
<FL val="Last Name">apellido</FL>
<FL val="Email">testing@testing.com</FL>
<FL val="Title">Manager</FL>
<FL val="Phone">1234567890</FL>
<FL val="Home Phone">0987654321</FL>
<FL val="Other Phone">1212211212</FL>
<FL val="Fax">02927272626</FL>
<FL val="Mobile">292827622</FL>
</row>
</Leads>
Is it necessary to send all the parameters in POST?
Yes, you have to send all parameters in POST.
What is the format of the xmlData parameter to associate a task or event to CRM records?
Use the following sample XML for relating an event with the account and contact respectively.
Accounts
<Events><row no="1">< FL val =" SEMODULE "> Accounts </FL>< FL val ="SEID"> 22222222222 </FL>< FL val ="Subject">test</FL>< FL val ="Start DateTime">12/12/2009 11:12:25</FL>< FL val ="End DateTime">12/12/2009 11:12:25</FL></row></Events>Contacts
<Events><row no="1&">< FL val = "SEMODULE "> Contacts </FL>< FL val = "CONTACTID "> 22222222222 </FL>< FL val ="Subject">test</FL>< FL val ="Start DateTime">12/12/2009 11:12:25</FL>< FL val ="End DateTime">12/12/2009 11:12:25</FL></row></Events>
Can I use the Record ID while associating a lookup field with a module?
Yes, you can use the Record ID while associating lookup field with modules (Ex: Associating a campaign with a lead or Account with a Contact).
If I am in the Free Edition, how many API requests can I make per day?
In the Free Edition, you can make a maximum of 1000 requests/day/organization.
What will happen if I do not specify a value for the newFormat parameter while fetching records?
The default value of "1" will be assigned to the newFormat parameter, if it is not specified while fetching records, i.e newFormat = 1.
Can I associate an account or contact while creating a task using an API?
Yes, you can associate a task created through an API with an account or contact. Here is the sample XML for associating a task with an account or contact:
<Tasks>
<row no='1'>
<FL val='Subject'>test 11111111</FL>
<FL val='Due Date'>20/2/2021</FL>
<FL val='CONTACTID'>xxxxxxxxxx</FL>
<FL val='SEMODULE'>Accounts</FL>
<FL val='SEID'>xxxxxxxxx</FL>
</row>
</Tasks> Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
FAQs: Cadences
What are Cadences? Cadences are a new tool in customer relationship management that changes the way businesses talk to their customers. It helps businesses make their marketing and sales plans better by being very precise and personal. This tool lets ...FAQs: Next Gen UI 2024
CRM for Everyone is in the Restricted Early Access mode and is available only to a select set of users upon request. Request access to gain hands-on experience with this new version. What is the purpose of the primary sidebar in the Next Gen UI 2024? ...Kaizen posts 2020: Other Developer Tools
Here is a complete list of Kaizen posts published in 2020, on developer tools other than APIs, SDKs, Functions and Client Scripts. Sl. No. Title Description 1 Connections This post helps you to explore Connections, its authentication types and ...Kaizen posts 2024: Other Developer Tools
Here is a complete list of Kaizen posts published in 2024, on developer tools other than APIs, SDKs, Functions and Client Scripts. Sl. No. Title Description 1 Leveraging ZDK CLI with VCS to reuse components across different Zoho CRM orgs Learn how ...Kaizen posts 2023: Other Developer Tools
Here is a complete list of Kaizen posts published in 2023, on developer tools other than APIs, SDKs, Functions and Client Scripts. Sl. No. Title Description 1 Automatic Mail-Merge Document Creation Using Zoho CRM APIs Learn how to use mail merge APIs ...
New to Zoho LandingPage?
Zoho LandingPage Resources