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 #197: Frequently Asked Questions on GraphQL APIs

                                                            🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
                                                          • Kaizen #198: Using Client Script for Custom Validation in Blueprint

                                                            Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
                                                          • Celebrating 200 posts of Kaizen! Share your ideas for the milestone post

                                                            Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQs
                                                          • Kaizen #193: Creating different fields in Zoho CRM through API

                                                            🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
                                                          • 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


                                                          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 Writer

                                                                                            Get Started. Write Away!

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

                                                                                              Zoho CRM コンテンツ




                                                                                                Nederlandse Hulpbronnen


                                                                                                    ご検討中の方




                                                                                                          • Recent Topics

                                                                                                          • How do you print a refund check to customer?

                                                                                                            Maybe this is a dumb question, but how does anyone print a refund check to a customer? We cant find anywhere to either just print a check and pick a customer, or where to do so from a credit note.
                                                                                                          • Notebook

                                                                                                            I have purchased the monthly pro subscription of Notebook. But it does not support my XP-Pen to write something in it. So it is not useful to me. Hence I am requesting you to help me to discontinue this subscription.
                                                                                                          • Domain Mapping & Image Publishing Issues on Zoho Sites

                                                                                                            Hello, I am facing two issues with my Zoho Sites account: 1. Images not visible after publishing. 2. Domain mapping error: "Domain already exists". I am a paid customer. Please connect me with Live Chat Support or Zoho Assist so I can show my issue
                                                                                                          • Prevent duplicate with custom fields?

                                                                                                            I was wondering something about custom field/custom modules in Zoho Desk. For some reason you can make a custom field mandatory but not unique? For example, if I create a custom module to manage equipment and renewal and make a field serial number no
                                                                                                          • Round robin

                                                                                                            Hi, I'm trying to set up a round robin to automatically distribute tickets between agents in my team but only those tickets that are not otherwise distributed by other workflows or direct assignments. Is that possible and if so which criteria should I
                                                                                                          • "Is Zoho CRM customer" vs "Is linked with Zoho CRM"

                                                                                                            Recently while building a Flow, I was setting up a Decision action following a Zoho Invoice Fetch record action. There were 2 choices that I had not seen as something I could manually action in Zoho Invoice: "Is Zoho CRM customer" and "Is linked with
                                                                                                          • Two currencies

                                                                                                            More and more I am finding that internattional payments' fees are unpredictable. I would like, on my invoices that are in a foreign currency (eg. USD$ or EUR€) for there to be a GBP£ TOTAL display alongside the invoice's currency total. This would make
                                                                                                          • Automatic Matching from Bank Statements / Feeds

                                                                                                            Is it possible to have transactions from a feed or bank statement automatically match when certain criteria are met? My use case, which is pretty broadly applicable, is e-commerce transactions for merchant services accounts (clearing accounts). In these
                                                                                                          • Generate leads from instagram

                                                                                                            hello i have question. If connect instagram using zoho social, it is possible to get lead from instagram? example if someone send me direct message or comment on my post and then they generate to lead
                                                                                                          • Kaizen #71 - Client Script ZDKs for Detail (Canvas) Page

                                                                                                            Hello everyone! Welcome back to another interesting Kaizen post. In this post, we can discuss Client Script ZDKs support for Detail (Canvas) Page. What is Detail (Canvas) Page? A Detail(Canvas) Page allows you to customize the record detail page to your
                                                                                                          • Where is the desktop app for Zoho Projects???

                                                                                                            As a project manager, I need a desktop app for the projects I manage. Yes, there's the web app, which is AWESOME for cross browser and platform compatibility... but I need a real desktop app for Projects that allow me to enter offline information where
                                                                                                          • How to Automate Monthly PDF Reports with Filters in Zoho Creator

                                                                                                            Hi everyone, I’m trying to build an automated monthly reporting process in Zoho Creator and would appreciate suggestions or best practices from anyone who has done something similar. What I’m trying to do: I have a form called New_Customer with fields
                                                                                                          • Feedback: Streamlining Note Management in Zoho Notebook

                                                                                                            Dear Team/Support, I would like to share some feedback regarding the note management system that could help improve usability and accessibility for users like myself. Notebook 1 (screenshot attached): Currently, the system does not allow selecting and
                                                                                                          • showing Limit exceeded

                                                                                                            Good afternoon...trust you're good. I've been having issues working with but it's not responding. it's showing Limit exceeded, sorry it seems like too many people are working on the sheet right now please try again later. meanwhile no one is working on
                                                                                                          • Converting Sales Order to Invoice via API; Problem with decimal places tax

                                                                                                            We are having problems converting a Sales Order to an Invoice via API Call. The cause of the issue is, that the Tax value in a Sales Order is sometimes calculated with up to 16 decimal places (e.g. 0.8730000000000001). The max decimal places allowed in
                                                                                                          • Sorting columns in Zoho Projects

                                                                                                            Hi, In project management best practice, sorting columns (ascending, descending) is an important tool. Sorting dates to see the order of tasks starting, sorting on priority or even on planned hours is a must for an efficient project control. Currently,
                                                                                                          • CRM : Function to add user name to text field

                                                                                                            I have a lookup field in a module that is linked to the CRM users so we can assign a Project Lead to the customer. Sadly Zoho Marketing Automation doesn't sync Lookup fields so I need to extract information from the lookup to text fields: Lookup field
                                                                                                          • Upload API

                                                                                                            I'm trying to use the Upload API to upload some images and attach them to comments (https://desk.zoho.com/DeskAPIDocument#Uploads#Uploads_Uploadfile) - however I can only ever get a 401 or bad request back. I'm using an OAuth token with the Desk.tickets.ALL
                                                                                                          • Losing description after merging tickets

                                                                                                            Hello, We merge tickets when they are about the same topic from the same client. It happens sometimes. We recently noticed that after the merger only the description from the master ticket is left in a thread. And the slave-ticket description is erased.
                                                                                                          • Option to Empty Entire Mailbox or Folder in Zoho Mail

                                                                                                            Hello Zoho Mail Team, How are you? We would like to request an enhancement to Zoho Mail that would allow administrators and users to quickly clear out entire folders or mailboxes, including shared mailboxes. Current Limitation: At present, Zoho Mail only
                                                                                                          • update linked contacts when update happens in account

                                                                                                            Hi, I have a custom field called Licence in the Accounts module. When someone buys a licence, I’d like to update a custom field in the related Contacts. How can I achieve this? I noticed that workflows triggered on Accounts only allow me to update fields
                                                                                                          • Problem Management Module

                                                                                                            I am looking for a Problem Management module within Zoho Desk. I saw in some training videos that this is available, and some even provided an annual price for it. I want an official confirmation on whether this is indeed available. This is not a particularly
                                                                                                          • Deluge sendmail in Zoho Desk schedule can't send email from a verified email address

                                                                                                            I am trying to add a scheduled action with ZDesk using a Deluge function that sends a weekly email to specific ticket client contacts I've already verified the email address for use in ZDesk, but sendmail won't allow it in its "from:" clause. I've attached
                                                                                                          • Unable to explore desk.zoho.com

                                                                                                            Greetings, I have an account with zoho which already has a survey subscription. I would like to explore desk.zoho.com, but when I visit it while logged in (https://desk.zoho.com/agent?action=CreatePortal) I just get a blank page. I have tried different
                                                                                                          • Offline support for mobile app

                                                                                                            Accessing your files and folders from your mobile devices is now quicker and simpler, thanks to the power of offline support. Whether on an Android or iOS device, you can use the Offline function to save files and folders, so you can review them even
                                                                                                          • Zoho Desk KB article embedded on another site.

                                                                                                            We embed KB articles from Zoho Desk on another site (our application). When opening the article in a new tab, there is no issue, but if we choose lightbox, we are getting an error "To protect your security, help.ourdomain.com will not allow Firefox to
                                                                                                          • Transitioning to API Credits in Zoho Desk

                                                                                                            At Zoho Desk, we’re always looking for ways to help keep your business operations running smoothly. This includes empowering teams that rely on APIs for essential integrations, functions and extensions. We’ve reimagined how API usage is measured to give
                                                                                                          • List of packaged components and if they are upgradable

                                                                                                            Hello, In reference to the article Components and Packaging in Zoho Vertical Studio, can you provide an overview of what these are. Can you also please provide a list of of components that are considered Packaged and also whether they are Upgradable?
                                                                                                          • Does Attari Messaging app have Bot option and APIB

                                                                                                            Hi, Does Attari also have Bot and API as we use in WhatsApp??
                                                                                                          • how to use validation rules in subform

                                                                                                            Is it possible to use validation rules for subforms? I tried the following code: entityMap = crmAPIRequest.toMap().get("record"); sum = 0; direct_billing = entityMap.get("direct_billing_details"); response = Map(); for each i in direct_billing { if(i.get("type")
                                                                                                          • How to add application logo

                                                                                                            I'm creating an application which i do not want it to show my organization logo so i have changed the setting but i cannot find where to upload/select the logo i wish to use for my application. I have seen something online about using Deluge and writing
                                                                                                          • Introducing Keyboard Shortcuts for Zoho CRM

                                                                                                            Dear Customers, We're happy to introduce keyboard shortcuts for Zoho CRM features! Until now, you might have been navigating to modules manually using the mouse, and at times, it could be tedious, especially when you had to search for specific modules
                                                                                                          • Empowered Custom Views: Cross-Module Criteria Now Supported in Zoho CRM

                                                                                                            Hello everyone, We’re excited to introduce cross-module criteria support in custom views! Custom views provide personalized perspectives on your data and that you can save for future use. You can share these views with all users or specific individuals
                                                                                                          • Send Automated WhatsApp Messages and Leverage the Improved WhatsApp Templates

                                                                                                            Greetings, I hope all of you are doing well. We're excited to announce a major upgrade to Bigin's WhatsApp integration that brings more flexibility, interactivity, and automation to your customer messaging. WhatsApp message automation You can now use
                                                                                                          • Verifying Zoho Mail Functionality After Switching DNS from Cloudflare to Hosting Provider

                                                                                                            I initially configured my domain's (https://roblaxmod.com/) email with Zoho Mail while using Cloudflare to manage my DNS records (MX, SPF, etc.). All services were working correctly. Recently, I have removed my site from Cloudflare and switched my domain's
                                                                                                          • Zoho Analytics Regex Support

                                                                                                            When can we expect full regex support in Zoho Analytics SQL such as REGEXP_REPLACE? Sometimes I need to clean the data and using regex functions is the easiest way to achieve this.
                                                                                                          • Change of Blog Author

                                                                                                            Hi, I am creating the blog post on behalf of my colleague. When I publish the post, it is showing my name as author of the post which is not intended and needs to be changed to my colleague's name. How can I change the name of the author in the blogs?? Thanks, Ramanan
                                                                                                          • Show Attachments in the customer portal

                                                                                                            Hi, is it possible to show the Attachments list in the portal for the particular module? Bests.
                                                                                                          • Does Zoho Docs have a Line Number function ?

                                                                                                            Hi, when collaborating with coding tasks, I need an online real time share document that shows line numbers. Does Zoho's docs offer this feature ? If yes, how can I show them ? Regards, Frank
                                                                                                          • Please make it easier to Pause syncing

                                                                                                            right now it takes 3 clicks to get there. sounds silly, but can you make it just 2 clicks to get it done instead? thats how dropbox does it, 2 clicks to pause instead of 3.
                                                                                                          • Next Page