Kaizen #38 - Calls #API

Hello everyone!

Welcome back to another post in the Kaizen series!

This week, we will discuss adding, updating, and deleting Calls via an API.

What are Calls in Zoho CRM?

The Log a Call functionality helps you to register the inbound calls (received from leads and customers) and outbound calls (dialed to leads and customers) with call details such as call duration, date and time of calls, notes, etc. Users who frequently make calls or receive calls in an organization can use this functionality in Zoho CRM.

Let us now see how you can work with Calls using APIs.

1. Inserting a Call Record

Use the Insert Records API to insert a record in the Calls module.

Request URL: {{api-domain}}/crm/v2/Calls

Request method: POST

Sample Input

{

"data": [

{

"Subject": "Call from +13012670261",

"Call_Purpose": "Prospective",

"Who_Id": "3652397000000649013",

"Call_Start_Time": "2020-06-25T10:30:00+05:30",

"Call_Type": "Outbound",

"$se_module": "Accounts",

"What_Id": "3652397000000624046"

}

]

}

Input JSON

Key	Data Type	Description
Subject	String	Subject of the call.
Call_Purpose	String	Purpose of the call. Use the Field Metadata API to get the values of this field. As this field is a picklist, when you specify a new value, the new value gets added to list of options in this picklist.
Who_Id	String	Record ID of the contact the call is related to.
Call_Start_Time	DateTime in ISO8601	The date and time when the call starts, in the ISO8601 format. This key is mandatory.
Call_Type	String	The type of call. The possible values are "Inbound", "Outbound", and "Missed". This key is mandatory.
What_Id	String	Record ID of the account or any other module the contact is associated with. If you want to create a call for a lead, specify the lead's record ID here.
$se_module	String	The API name of the parent module of the associated contact. In case the What_Id, is a lead's ID, the value for this key will be "Leads".
Call_Duration	String	The duration that the call lasted for, in the hh:mm format. This key is mandatory for completed calls.

Things of Note

Who_Id is always a contact's record ID.
If you want to create a call for a lead, specify the lead's record ID in the What_Id key and the value of $se_module as Leads.
If the Call_Start_Time is in the past (not current time), it is considered as a completed call, and Call_Duration becomes mandatory.
For a missed call, if you specify Call_Duration, the system ignores the call duration.

Sample Response

2. Updating a Call

Use the Update Specific Record API or Update Records API to update the call(s).

The input keys are similar to the ones mentioned in the Insert Call section.

Request URL: {{api-domain}}/crm/v2/Calls/3652397000002171008

Request method: PUT

Errors common to inserting and updating a call

Error code	Reasons	Handling
INVALID_DATA	1. The call_start_time is empty. 2. The value of the call_start_time key is in an incorrect format. 3. For a completed call, the call_duration is empty. 4. The value for the call_type key is incorrect. 5. You are trying to update the Call_Type. 6. You are trying to update the Owner of a completed call. 7. You have provided an incorrect Call_Start_Time for a completed call.	1. You must specify the call_start_time. 2. The value for the call_start_time key must be in the ISO8601 format. 3. You must specify the call_duration for a completed call. 4. Specify the correct value for the call_type key. 5. You cannot update the Call_Type key through the PUT request. 6. You cannot update the Owner of a completed call. 7. For a completed call, the sum of the Call_Start_Time and the call duration must not exceed the current time.
MANDATORY_NOT_FOUND	While updating multiple calls, you have not specified the record IDs in the request body.	Specify the record ID of the calls that you want to update in the request body.

3. Deleting a Call

Use the Delete Specific Record API or Delete Records API to delete the call(s).

Request URL: {{api-domain}}/crm/v2/Calls/3652397000002172001

or {{api-domain}}/crm/v2/Calls?ids=3652397000002172001,3652397000002171002

Request method: DELETE

Note: You can pass a maximum of 100 record IDs in the ids parameter.

Sample response

We hope you found this post useful.

Write to us at support@zohocrm.com if you have any questions, or let us know in the comment section.

Cheers!

Access your files securely from anywhere

Zoho Developer Community

New to Zoho LandingPage?

Access Zoho LandingPage

Zoho LandingPage Resources

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Tout forum

France ZUGs

Zoho SalesIQ Resources

Topic Participants
Shylaja S

Sticky Posts
Kaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provide
Client Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands
Extension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use API
Kaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved
Extension pointers for integrating Zoho CRM with Zoho products #8: Upload and manage Zoho Workdrive folders and files from within Zoho CRM
Keeping records on your customers and business prospects is essential for tracking data, conducting follow-ups, and running a business smoothly. When you use two separate applications, and store relevant data in each, checking and tracking data becomes