Kaizen #38 - Calls #API

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




                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                  • Ask the Experts



                                                            • Sticky Posts

                                                            • Kaizen #217 - Actions APIs : Tasks

                                                              Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.
                                                            • Kaizen #216 - Actions APIs : Email Notifications

                                                              Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are
                                                            • 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
                                                            • Kaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script

                                                              Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.
                                                            • Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI

                                                              Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over the


                                                            Manage your brands on social media



                                                                  Zoho TeamInbox 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

                                                                                      • CRM Community Learning Series

                                                                                        CRM Community Learning Series


                                                                                      • Kaizen

                                                                                        Kaizen

                                                                                      • Functions

                                                                                        Functions

                                                                                      • Meetups

                                                                                        Meetups

                                                                                      • Kbase

                                                                                        Kbase

                                                                                      • Resources

                                                                                        Resources

                                                                                      • Digest

                                                                                        Digest

                                                                                      • CRM Marketplace

                                                                                        CRM Marketplace

                                                                                      • MVP Corner

                                                                                        MVP Corner







                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now


                                                                                            Zoho Show Resources

                                                                                              Zoho Writer

                                                                                              Get Started. Write Away!

                                                                                              Writer is a powerful online word processor, designed for collaborative work.

                                                                                                Zoho CRM コンテンツ



                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                              • Recent Topics

                                                                                                              • Email Template Edits Not Saving

                                                                                                                I can make an edit, click save, and see the blue bar annimation at the top, but the edits don't actually save. Important, because my email templates are now broken and clients are receiving bad emails. Tried on Chrome, Firefox and IE.
                                                                                                              • Tracking Snippet not working in Zoho Marketing Automation!

                                                                                                                First off, the fact that you have to wait about 12-24 hours for every response is terrible. How are we supposed to conduct business? Second, we have been trying for several days to get the Tracking Code Snippet in marketing automation to work, to no avail.
                                                                                                              • email moderation issue when email is sent in the name of a mail group

                                                                                                                Symptom: an email that is sent by a mail group moderator in the name of a moderated mail group is held back for approval. Reproduction: Create a moderated mail group with members and moderators. Allow that mails can be sent in the name of the group (extended
                                                                                                              • Is there any way to send an Excel received by email to Dataprep?

                                                                                                                Every day I receive an email alert with an Excel file that I want to process through a Dataprep pipeline. To do this, I need to: -Save the file to disk -Open the pipeline -Run the pipeline -Update the source -Several clicks to select and open the saved
                                                                                                              • BUG: Can't copy-paste data outside Sheet

                                                                                                                Currently I can't paste data copied from inside any of my Zoho Sheet files to any other app. Copy-paste works inside the sheet It does NOT work between two different sheets These sheets are built from automation templates Everything works fine if I create
                                                                                                              • Recruit paid support?

                                                                                                                Hi all, Could anyone who has paid support package advise if it provides value for money with regards to support response times? Exploring the idea as unfortunately when we have faced issues with Recruit it has been a 7+ day timescale from reporting to
                                                                                                              • Using IMAP configuration for shared email inboxes

                                                                                                                Our customer service team utilizes shared email boxes to allow multiple people to view and handle incoming customer requests. For example, the customer sends an email to info@xxxx.com and multiple people can view it and handle the request. How can I configure
                                                                                                              • Add Lookup Field in Tasks Module

                                                                                                                Hello, I have a need to add a Lookup field in addition to the ones that are already there in the Tasks module. I've seen this thread and so understand that the reason lookup fields may not be part of it is that there are already links to the tables (
                                                                                                              • Hotmail is blocking the zoho mail IP

                                                                                                                Greetings, Since last Tuesday (5 days ago today) I wrote to Zoho support and I still haven't received a single response (Ticket ID: 2056917). Is this how you treat people who pay for your email service? I am making this public so that those who want to
                                                                                                              • Client Portal ZOHO ONE

                                                                                                                Dear Zoho one is fantastic option for companies but it seems to me that it is still an aggregation of aps let me explain I have zoho books with client portal so client access their invoice then I have zoho project with client portal so they can access their project but not their invoice without another URL another LOGIN Are you planning in creating a beautiful UI portal for client so we can control access to client in one location to multiple aps at least unify project and invoice aps that would
                                                                                                              • Read webpage - MSXML2.ServerXMLHTTP

                                                                                                                I have the following VBA script, put together from various sources (mainly zoho forum/help/support, so it once worked, I guess): private Sub GetListOfSheets() Dim url As String Dim xmlhttp As Object Dim parameters As String Dim html As String range("B1").value
                                                                                                              • Zoho Creator Form Search

                                                                                                                I'm new to Zoho Creator and so far i do like it but im shocked there seems to be no easy way to add a search function and/or navigation to there forms as this readily available in every platform i have used in the past. Anyway i have a form which i have
                                                                                                              • How to setup DKIM / SPF in Zoho Mail

                                                                                                                Hello there! I'm having a hard time understanding how to setup the TXT records for SPF and DKIM with Zoho Mail. I'm following the instructions here: https://www.zoho.com/campaigns/help/setup-spf-dkim.html Specifically, when it comes to the value for the
                                                                                                              • Mass update cant trigger a workflow?

                                                                                                                Hello there, Is this a normal Creator behaviour? In a report, if I manually edit each data row, it will pass those changes to all other reports. However, if I perform a Mass Update on a few data rows at once, the new data is not pushed to other reports.
                                                                                                              • Default Ticket View - Table?

                                                                                                                Guys, We mostly use the table view to queue tickets. Maybe I am missing it - but how can I set that view as 'default" for all our agents? Thanks JV
                                                                                                              • Exciting Updates to the Kiosk Studio Feature in Zoho CRM!

                                                                                                                Hello Everyone, We are here again with a series of new enhancements to Kiosk Studio, designed to elevate your experience and bring even greater efficiency to your business processes. These updates build upon our ongoing commitment to making Kiosk a powerful
                                                                                                              • search and Smart Bar both missing in Mail

                                                                                                                One of the users on my account does not have the search bar at the top right or the Smart Bar at the bottom left of the desktop Mail app. Any ideas how to get those back?
                                                                                                              • "Wrong password or login" Problem to configure Zoho on MAIL App on my Macbook

                                                                                                                Hi, I'm having problems to configure my e-mail on my MAIL App(Macbook pro). My e-mail is hari@trespontoum.net Actually was working perfectly, and still working on my Iphone. My MAIL App prompt me that my login or password is wrong. I tried to change 3
                                                                                                              • Presenting ABM for Zoho CRM: Expand and retain your customers with precision

                                                                                                                Picture this scenario: You're a growing SaaS company ready to launch a powerful business suite, and are looking to gain traction and momentum. But as a business with a tight budget, you know acquiring new customers is slow, expensive, and often delivers
                                                                                                              • Possible for first Signer of Sign Form to specify the next signer in the sequence

                                                                                                                We have many use cases where multiple signers need sign the same document. We'd love to be able to use sign forms, where the a signer who uses the Sign Form link can specify the name and email address for the next person in the sequence.
                                                                                                              • Duplicate customers being created in Desk

                                                                                                                Hi I've trying to work out why I've getting duplicated customers being created in my desk. I have an external booking system that generates an email when I get a customer booking a job. A booking email gets sent to Desk where I manage the booking and
                                                                                                              • Remote Control Functionality During Screen Sharing in Zoho Cliq

                                                                                                                Hello Zoho Cliq Team, We would like to request the addition of remote control functionality during screen sharing sessions in Zoho Cliq. Currently, while screen sharing in Cliq is very useful, it lacks the ability for another participant to take control
                                                                                                              • Let us add Lookup fields in the Blueprint Transitions

                                                                                                                We are unable to add Lookup Fields in the blueprint transitions in Zoho Desk, we wanted to make it a requirement for our workflow but since it's not available in the transition we cannot. The lookup field exists in the Layout: But it cannot be added/selected
                                                                                                              • Zoho Projects API Scope for Issue Attachments

                                                                                                                I try to download issue attachments via the API, unfortunately I always get the following error code when trying to download the file from the supplied URL: {"ERROR_MESSAGE":"INVALID_OAUTHSCOPE","ERROR_CODE":401} indicating an auth scope error. I've tried
                                                                                                              • How to fetch custom fields for time entries in Zoho Project API v3

                                                                                                                In the previous Zoho Projects REST API, we were able to retrieve custom field details for time entries, including picklist options, using the endpoint: GET /restapi/portal/[PORTAL_ID]/timesheetcustomfields In the new Zoho Projects API v3, we tried using
                                                                                                              • Zoho Survey Enhancements

                                                                                                                We love Survey. We use it a ton. It needs some enhancements. Maybe some of these are already on the roadmap? API - this is crucial. We have some complex surveys that take place and need to update records, trigger other functions/automations, etc. I would
                                                                                                              • Images Don't Display on Blog

                                                                                                                Hi, I've just posted a new blog entry, but regardless of format (png or jpeg) Images that display in Preview mode do not display on any browser in the published post.  I've not done anything different with this post than others regarding images, please advice. Thanks! Edit:  I've discovered that moving the image files from a my sub directory folder "Pics for Blog" to the top level of the "Files" folder on my site allows the images to display live.  This, even though my other blog posts are correctly
                                                                                                              • Checkbox Field Mapping Zoho Forms to Zoho Sign

                                                                                                                I have an application that will be filled out via Forms that I am mapping into a PDF Filler on Zoho Sign. I need to have a series of checkboxes mapped to the corresponding fields in Sign and I only see single checkboxes available via the mapping, though
                                                                                                              • MCP > Creator connection failing with Claude

                                                                                                                I'm trying to get claude to access any of my Zoho Creator apps and it keeps failing. I have enabled all tools for creator and ensured in claude settings that everything is authorised. Here is what claude says : Unfortunately, the error messages I'm receiving
                                                                                                              • WorkDrive and CRM not in sync

                                                                                                                1/ There is a CRM file upload field with WorkDrive file set as the source: 2/ Then the file is renamed in WorkDrive (outside CRM): 3/ The File in CRM is not synced after the change in WorkDrive; the file name (reference) in CRM record is not updated (here
                                                                                                              • Books P&L by Customer

                                                                                                                Lately, we have found that the Customer field filter for the Profit & Loss report in Zoho Books is no longer available. We have several projects with the same customer and look at the P&Ls by project AND by Customer (overall). Can you please add back in this field selection alongside the Project field to the P&L report filter? Thanks! -Gina
                                                                                                              • Sent mail sort by date disappeared

                                                                                                                Hello, We used to be able to sort the emails by date in the sent folder, but this feature has recently disappeared. Can we bring it back?
                                                                                                              • I cannot check out to Zoho People.

                                                                                                                When I tried to check out today, there's prompt that inhibits me to check out: To add entry in Attendance, log time for any of your jobs
                                                                                                              • Pricing Strategies: #2 Plan your Service Offerings using Plans

                                                                                                                Meet Harvey & Mia, hailing from the same Tech school, carrying the dream of setting up their own IT maintenance firm in their location. They drew up a clear business plan and put their business in motion on New Year's Eve. They had great reception right
                                                                                                              • Open a record to edit based on another form being edited

                                                                                                                Hi all, I am trying to edit a record based on another record being edited. It works out like this: When I create a Monthly_Update and then submit I open the Monthly_Levels form and pass the ID from the Monthly_Update to a field called mu. I want it to
                                                                                                              • Problem with signature on zoho survey

                                                                                                                Hello, I'm trying to export individual responses with signatures on zoho survey. But the signatures on some of my surveys are not exported as the original image, but as a generic image, same for all (screen joins). Is there a solution to have the signatures
                                                                                                              • Change in Zoho CRM API?

                                                                                                                Hello, I am using the Zoho API trough the PHP SDK v2.1 Since few days, I noticed that I have to change the way I pass the data to the API when I create, update, or upsert a record. Dates Before I was passing a PHP date object to "$record->addKeyValue(...)",
                                                                                                              • How to view CRM Sales Orders in Desk

                                                                                                                What's the usual way to view all CRM sales orders linked to a contact, when viewing a ticket in Desk? I don't want to have to open a new tab to see the order in CRM. And the Desk CRM sidebar doesn't seem to be configurable. Would I have to use an extension
                                                                                                              • MTA - BAD IP reputation by outlook/hotmail

                                                                                                                Messages to Microsoft email servers are bouncing back due to poor reputation. Message: 4.7.650 The mail server [136.143.188.206] has been temporarily rate limited due to IP reputation. For e-mail delivery information see https://postmaster.live.com (S775)
                                                                                                              • QuickBooks Extension for Zoho CRM - Advanced Features -2025

                                                                                                                Hello Everyone, We’re happy to announce the latest version of our QuickBooks Extension for Zoho CRM, now officially live on the Zoho Marketplace! This release introduces one-click data sync, a user-friendly UI, enhanced performance, and a powerful set
                                                                                                              • Next Page