Read about the CRM Authentication Token in our Developer API Forum .

If you are an existing Developer API user and you are using the API Ticket and API Key in all your API calls, it is recommended that you replace the URLs with the CRM Authentication Token. Click here  to learn about the Authentication Token.

1. How do I benefit from using the Auth Token?

The Auth Token is permanent and unlike the API Ticket, you DO NOT have to generate a new token every 7 days.

2. How do I replace the API Key and Ticket with the Authentication Token?

The format for generating the Authentication Token is:

https://accounts.zoho.com/apiauthtoken/nb/create?SCOPE=ZohoCRM/crmapi&EMAIL_ID=Zoho CRM Username or Email ID&PASSWORD=Your Zoho CRM Password

So, the API call to fetch all leads from the Leads module will be:

https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?newFormat=1&authtoken=7d987676893g4j09h43dd0b167dda34b&scope=crmapi&cvName=All Open Leads

 API Limit

For instance, in the Free Edition, if you use the;getRecords;method, you can fetch a maximum of 200 records per request, in turn, a total of 50,000 records per day (250 x 200 = 50,000 records).

Important:; If you use the;getSearchRecords;or;getCVRecords;methods, you can send a maximum of;250 Requests per day;irrespective of your Zoho CRM edition.;

 To Generate API Key;(only for Existing API Users)

1. Log in to Zoho CRM with Administrator's privilege.
2. Go to Go to Setup > Developer Space > APIs > CRM API Key.
3. You will find a section like this:;
   If you are still using CRM API Key for Authentication,Click here.
4. Clicking the link will display the API Key.

 To Generate Ticket ;(only for Existing API Users)

While initiating API request, you must pass the ticket parameter (encrypted alphanumeric string) to authenticate the user credentials with Zoho. To generate a ticket for a particular user, you need to send an authenticated HTTPS POST request over a secured connection to Zoho Accounts.

Sample form POST format with supported parameters:

The mandatory parameters along with their values to be passed in the URL are:

Depending on the parameters passed over to the requested URL,;you will get a response in the format given below:

Example 1: Successful Ticket Generation Pattern

Example 2: Failure Ticket Generation Pattern

Important Notes:

• Your API ticket is valid for 7 days. After 7th day, you must generate a new ticket to work with Zoho CRM - API service. If you are not updating the application with a new ticket ID, you will receive 4834 - Invalid Ticket ID error response from API request.
• You are strongly recommended not to generate API ticket for every API request. You can use the same ticket in your application for 7 days without any issues.
• You can have only a maximum of 20 active sessions.

If you have more than 20 active sessions, you will get a response like this:

CAUSE=Maximum Concurrent User Tickets Limit ExceededRESULT=FALSE
You can follow any of the following measures to avoid crossing the concurrent API sessions limit.
Reuse the API ticket: An API ticket once generated can be used for a period of 7 days. You have to generate a new ticket only after 7 days.
Logout:Clear/Logout the ticket after you have completed the operation.

An HTTPS POST request to clear/logout api ticket will look like this:

Close Sessions: Go to https://accounts.zoho.com/  Click Active Sessions > Click Close all other sessions.

 Test Program

Here's a sample program to regenerate the API ticket after it becomes invalid.

Program