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?
Zoho LandingPage Resources
New to Zoho Survey?
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
New to Bigin?
Topic Participants
Shylaja S
Sticky Posts
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! CommandsKaizen #165 : How to call Zoho CRM APIs using Client Script
Welcome back to another exciting Client Script post! In this post, we will discuss one of the most frequently asked questions: How do you call Zoho CRM APIs from Client Scripts? In this kaizen post, 1. Ways to make calls to Zoho CRM APIs using ClientKaizen#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 provideExtension 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 APIKaizen #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
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Customising the approval email
Is there anyway to customise the Approval email or to add further fields as the default looks so basic and unlike any of the other email notifications from Desk. My users just thought it was spam.Pushing GCLID info from Gravity Forms to ZohoCRM
We are switching to Gravity Forms from Zoho Forms and I cannot find any good info on how to make sure my GCLID tracking info is pushed through to the CRM through my new forms. There was an article in the documentation about placing something within theIssue Configuring SSO Integration with Cognito in Zoho Help Center
Dear Zoho Support Team, We have been working on configuring SSO integration for our Zoho Help Center using Amazon Cognito. While the setup appears to be completed successfully, we are encountering an issue when attempting to access the Help Center. TheNeed manual aggregate column pathing help
See linked video here: https://workdrive.zohoexternal.com/external/a5bef0f0889c18a02f722e59399979c604ce0660a1caf50b5fdc61d92166b3e7Merging contacts does fail because of help center membership
I'm trying to merge two contact records (they are the same contact) where one of them is a member on the help center. The system warns me about this situation and then I de-activate this contact as an "End User" for the help center. Right now the systemDuplicate Contacts - how to get merge or delete
I have noticed that our list of contacts in Zoho Desk duplicates contacts periodically. I have yet to identify when or why. How do I merge or delete them? I see there is a "Deduplicate" but I am unable to find anything that explains this feature.Admin Access to Direct Messages in Zoho Cliq
Hi Zoho Cliq Team, We would like to request a feature enhancement to enable admin access to one-on-one conversations (direct messages) conducted through Zoho Cliq. Use Case: As administrators, there are situations where it becomes essential to access"Mark as Spam" not working as expected
Dear support, in the below scenario, clicking on "Mark as spam" identifies only the first of the checked emails as spam, removes that email from the visible list and leaves the rest of the list still visible & unchecked. I've tried check-marking themMassive price increase for user licenses of Zoho Portal
This actually a complaint about this announcement: https://help.zoho.com/portal/en/community/topic/free-user-licenses-across-all-portal-user-types You present this as an enhancement. And, yes, while reading the main part, I'd agree that (for smaller companies),Elevating Email Security on Zoho Desk: DKIM Now Mandatory
Hello Zoho Desk Users! It has been a wonderful journey with you on Zoho Desk. As we welcome 2025, we are strengthening our efforts to ensure a secure and seamless experience for you. To enhance email security, DKIM configuration will be mandatory forCalendar - "super compact" week view
every time i go to my calendar i have to re-engage the "super-compact view" for the week view...is there a way to make "super-compact" a default view so I dont have to keep on setting it manually?Calendar - "pop up" locations
One of the attractive features of google calendar and outlook calendar is that locations for events will start to automatically populate the location drop down menu as you type. Adding this feature to zoho calendar would be the final feature i need.Using Zia in Zoho Sheet data to research the internet and return answer to a cell in Zoho Sheet
I'm trying to see if Zia (connected with OpenAI key) can take data parameters stored in a Zoho Sheet to conduct research out on the internet then return an answer into the same Sheet. I'm trying to do the equivalent of using something like the =AI() function[Free Webinar] Learning Table Series - Creator for the Education Industry
Hello Everyone! We're thrilled to invite you to the Learning Table Series—a year-long initiative to demonstrate how Zoho Creator can transform industries with innovative and automated solutions. Each month focuses on a specific industry, and this time,Remove the [## XXXX ###] from subject replies
For our organisation we would like to have the [## XXXX ###] removed from subject replies. Cheers, Jurgen 365VitaalWerkenSelf Client Authorization Issue
Hi. Trying to test the api integration for Zoho Desk with the Self Client - Client Credintials flow method. I've created the self client, obtained the client id and secret, inputted "Desk.tickets.ALL" as my scope, and "ZohoDesk.[My Zoho Desk Org ID]"How Can I Easily Access and Manage My GEPCO Online Bill Using Zoho Sheets?
Hello everyone, I'm looking for an efficient way to access and manage my GEPCO online bills. I've heard that Zoho Sheets can be a powerful tool for organizing and tracking bills, but I'm not sure how to set it up for this specific purpose. Does anyoneAll notes disappeared
I've been using the notebook app for over five years on my phone without being logged into an account. A few days ago I opened the app and all my notes had disappeared. Since then I tried restarting my phone, updating the app and logging into my account,How to add tags to a record with jS SDK 1.2/ZohoEmbededAppSDK
Hello Is it possible to add tags to a record with jS SDK : https://live.zwidgets.com/js-sdk/1.2/ZohoEmbededAppSDK.min.js ZOHO.CRM.API.updateRecord Thanks for insightsURGENT: Zoho Forms reCAPTCHA v2 Spam Issue
Hello Everyone, We are encountering a critical issue with Zoho Forms despite having reCAPTCHA v2 enabled. Our business is accessibility-focused, and we are receiving a high volume of spam submissions, which is significantly affecting our workflow andView all Products by pipeline deal
Very good CRM I use it everyday only problem is modules not being interconnected especially products module. The main problem of products module are separated from contacts and company modules and only being connected to the Deals module. This way there'sAdd "Lead Image" in Bulk?
Each of our Leads is accompanied with a URL containing a photo of the lead when they come in. We currently have to manually download then upload the photo to the lead. This is a HUGE waste of time. Is there any way to AUTOMATICALLY add the photos to theMap fields from CRM record to Finance Suite/Books Invoice fields
I'm trying to auto-fill unique record specific field inputs that I have in my Contacts and Deals modules onto Invoices created from the record's finance suite related list upon creation. One example is a field called "Job Number" that I have in my ContactAdd and Remove Agents from Departments and Groups in Zoho One
Hi Zoho Flow Team, We hope you're doing well. Currently, Zoho Flow provides an action to add an agent to a group in zoho one, but there is no action to remove an agent from a group or a department. Another action that we find missing is the option toZoho CRM - best way to search an account and assign to a deal
Hi Everyone I am looking for some advice. I want to find the best way to complete the below steps. We have a deal and once it reaches a certain stage we need to allocate a supplier / vendor to this deal along with the salesperson. I want to add (ideallyWhat's New in Zoho Analytics - December 2024
Hello Users! We’re excited to bring you a roundup of the latest features and improvements in Zoho Analytics. These updates are designed to elevate your data analytics experience, making it more powerful, interactive, and seamless. Let’s dive in! Expandedtrying to access CRM Variables with JS SDK
Hello i built a widget with Sigma, i create CRM VARIABLES in custom properties. I try to access them in function : ZOHO.embeddedApp.on("PageLoad",function(data) with : ZOHO.CRM.CONFIG.getVariable("mycrmvariable").then(function(data){ console.log("mycrmvariableWriting on sketch cards is bugged when zoomed in
When zoomed in, it writes a noticeable distance above or to the side of where you're actually trying to write. The further you're zoomed in, the more noticeable it is. Zooming is also entirely absent on the desktop version.Private Project
Hi, I would like to know if a user can create a Private project that only he's able to see it. Not even the ADMIN user. ThanksApple Messages for Business in Omnichannel communications?
Hello, Apple launched "Apple Messages for Business" but Zoho CRM or Zoho Desk don't appear in the list of possible integrators. Zoho already promotes https://www.zoho.com/crm/omnichannel.html Omni Channel integration, but Apple Messages does not yet appear.Accordion in tabs to create FAQs, etc.
Accordion elements do not seem to be able to be placed in the tabs. It would be useful to be able to do this. Thank you.Which are the IP addresses to use for 'split delivery' with Office 365? (Zoho mail inbound gateway)
Hi, I'm trying to set up 'split delivery' (email routing) with Office 365. I'm following the instructions to set up Office 365 as the primary server (https://www.zoho.com/mail/help/adminconsole/coexistence-with-office365.html) One of the prerequisitesZoho Projects 2024 Recap
Dear Users, As we conclude another remarkable year, it's the time to reflect on the journey we've just completed. The year 2024, defined by significant milestones, challenges, achievements, and important lessons. Every moment has contributed to the storyCustom Fields at Line Level
Hi, is there an ability to add custom fields at line level? I need to track the start and the end date for each product within an invoice and I can't seem to find an option to do this.Zoho API Error Code 7019 when adding job.
Hello, I am following the documentation found here. https://www.zoho.com/people/api/timesheet/adding-jobs.html Regardless of how I try and post the data (including just using the example requests), I receive back the response {'response': {'message':How to see changes with ZOHO.CRM.API.updateRecord(config) without reload page
hello got a widget in account, trigger with a button i copy data to account when click on a button, in my popup All is working well. But i need to reload the page to see the update. How can i see the changes without reloading page, only when close theHow to call a Creator function which is in a different Creator application?
How to call a Creator function which is in a different Creator application?Unable to send message; Reason: 554 5.1.8 Email Outgoing Blocked
My account is mino@flawless-frames.com, or flawlessframesstudio@gmail.com Could you please unblock my account, I've got restricted from sending more emailsStock Count
The stock count is a nice new feature, but we cannot figure out how to: 1. Use it without assigning to a person, we have a team or one of multiple do stock counts as do most any company. 2. Add any extra fields to what the "counter" sees. The most importantMove a Contact from Current Account to a NEW Account
I do not believe the functionality to Move a Contact from a Current Account to a New Account is not available. Please someone tell me I am missing something! I have been through designing, developing, using and selling CRM systems for over 25 years and had this functionality20+ years ago in other CRMs. In the real world people move from one organisation to another. In the sales, finance and technical world it is nice to see the communication history with that person in their old account and alsoNext Page