11 Common API Errors and How to Prevent Them

11 Common API Errors and How to Prevent Them

Zoho Contracts offers an extensive set of APIs using which you can integrate with your applications and build custom solutions. However, while using them and executing your code, you might face some errors. The reason might be due to any of the following reasons listed below.  

  1. Check the given connection is active and the connection link name provided within the script is correct. 

  2. Check the user who authorized the connection has permission to perform the request.

  3. Check the connection has applicable scopes to perform the requested action (e.g., contracts.contracts.READ to get any contract's detail).

  4. Check the domain name in the API URL points to the data center in which you have your Zoho account (e.g., if your account is in the EU data center, the URL should start with https://contracts.zoho.eu/).

  5. Check the method of the request type is correct (e.g., POST for creation).

  6. Check the JSON input has no syntax errors.

  7. Check you have given values for all mandatory fields in the input parameters. It includes fields that are applicable and mandatory based on another field's value (e.g., in Create Contract API, renewal-type is mandatory when the contract is renewable).

  8. Check JSON keys that require API names are appropriately passed. For example, in the create contract API, the value for the contract-type key should contain its API name instead of the actual name.

  9. Check the format of the values passed are as expected. For example, the date format of a date value should be in the DD/MM/YYYY format, and the date format of a date value for the document fields should be in the timestamp format (e.g., the timestamp format of 6th July 2023 is 1687641600).

  10. Check the JSON parameter passed is stringified. You can refer to the parameters attribute in the below Deluge sample code.

    createdCounterpartyResponse = invokeurl [
       url: "https://contracts.zoho.com/api/v1/counterparties"
       type: POST
       parameters: toString(newCounterpartyDetail)
       connection:"zcontractsconn"
    ];

  11. For creating a contract using API, if you need the values to be passed for the document fields, check whether the request URL is "https://contracts.zoho.com/api/v1/createcontract", and the externalSource attribute is set with true.

For any assistance in using our APIs, feel free to post on our Developer Community. 

Happy Coding!

Cheers,
SK
Solutions Consultant


      Zoho Campaigns Resources


        • Desk Community Learning Series


        • Digest


        • Functions


        • Meetups


        • Kbase


        • Resources


        • Glossary


        • Desk Marketplace


        • MVP Corner


        • Word of the Day


        • Ask the Experts


          • Sticky Posts

          • 11 Common API Errors and How to Prevent Them

            Zoho Contracts offers an extensive set of APIs using which you can integrate with your applications and build custom solutions. However, while using them and executing your code, you might face some errors. The reason might be due to any of the following
          • Organization Parameter in API Calls

            Zoho Contracts now supports the multi-org feature where users can be part of multiple organizations. You can now manage contracts across multiple organizations with separate Zoho Contracts accounts for each organization. Users who are part of multiple
          • Zoho Contracts API Documentation

            Greetings! The API documentation of Zoho Contracts is now available. Please access it from the below link. https://www.zoho.com/contracts/api/introduction.html You can post your queries and problems relating to Zoho Contracts API in this developer forum.

          Zoho CRM Plus Resources

            Zoho Books Resources


              Zoho Subscriptions Resources

                Zoho Projects Resources


                  Zoho Sprints Resources


                    Zoho Orchestly Resources


                      Zoho Creator Resources


                        Zoho WorkDrive Resources



                          Zoho CRM Resources

                          • CRM Community Learning Series

                            CRM Community Learning Series


                          • Tips

                            Tips

                          • Functions

                            Functions

                          • Meetups

                            Meetups

                          • Kbase

                            Kbase

                          • Resources

                            Resources

                          • Digest

                            Digest

                          • CRM Marketplace

                            CRM Marketplace

                          • MVP Corner

                            MVP Corner




                            Zoho Writer Writer

                            Get Started. Write Away!

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

                              Zoho CRM コンテンツ










                                ご検討中の方

                                  • Recent Topics

                                  • Automation #11 - Auto Update Custom Fields with Values from Emails

                                    This is a monthly series designed to help you get the best out of Desk. We take our cue from what's being discussed or asked about the most in our community. Then we find the right use cases that specifically highlight solutions, ideas and tips to optimize
                                  • Email notification for followers

                                    Is there a way to enable email notification for followers of a support ticket? ie: Ticket #123 is owned by Agent#1, Agent#2 adds themselves as a follower. Whenever ticket #123 receives an email from the customer, Agent#1 receives an email. Agent#2 would
                                  • Unified WhatsApp Number Management in Zoho Desk and SalesIQ

                                    Dear Zoho Desk Support Team, We are currently utilizing both Zoho Desk and Zoho SalesIQ for our customer support operations. While both platforms offer WhatsApp integration, we are facing challenges due to the requirement of separate WhatsApp numbers
                                  • Add picklist in subform lookup

                                    Hello, I am trying to rewrite a script that works on a from as parent form, to the same form when is is a subform. Here is what I did in the form itself : RefCat = Offre_de_produits.distinct(Categorie_OFFRE); clear Categorie_LIGNE; for each Record in
                                  • Zoho Desk is extremely slow

                                    Hi Team, We are facing extreme latency issue with Zoho Desk. It is currently unusable. I have submitted a ticket already could you please look into this asap. Regards, Priya Sharna
                                  • Zoho Desk is extremeley Slow

                                    Hi, Zoho Desk seems to be extremely slow for the last 15 mins for everyone in our team (5 people). https://status.zohocloud.ca/ didn't show any status in this regard. Would it be possible to have an idea what is happening and when this should be resolved?
                                  • Help Centre - Widget or Tab for Customer Downloads

                                    USE CASE: We are a software vendor, using Zoho Desk (as part of a Zoho One subscription) to help mange support issues from our customer base. Customers can log tickets via email or Help Centre portal. QUESTION: I need to provide the capability for our
                                  • Integración Books para cumplir la ley Crea y Crece y Ley Antifraude (VeriFactu)

                                    Hola: En principio, en julio de 2025, entra en vigor la ley Crea y Crece y Ley Antifraude (VeriFactu). ¿Sabéis si Zoho va a cumplir con la ley para cumplir con la facturación electrónica conectada a Hacienda? Gracias
                                  • How to let only account-bound products visible to users

                                    Hello friends, I'm trying to leave only the Products linked to the accounts visible to Zoho Portal users. If the user clicks "All Products," they can open tickets incorrectly for products that do not belong to the account that are registered. Is it possible
                                  • Work Orders / Bundle Requests

                                    Zoho Inventory needs a work order / bundle request system. This record would be analogous to a purchase order in the purchasing workflow or a sales order in the sales cycle. It would be non-journaling, but it would reserve the appropriate inventory of
                                  • Try CRM for everyone button in the way of workflow

                                    Please consider using the bottom bar for offers. Using the top bar for offers like "Try CRM for everyone" really gets in the way of my day to day workflow.
                                  • Markdown for Desk?

                                    Hi, my company wants to use markdown for formatting text in Desk (in all modules there, especially Tickets and Helpcenter). Zoho already offers use of markdown in several products (see https://help.zoho.com/portal/en/kb/backstage/microsite-guide/formatting-with-markdown/articles/formatting-with-markdo)
                                  • Limits on workflow never disclosed, not documents and now being applied. I feel scammed and there is no reply for support.

                                    Hello everyone, I’m facing a critical issue with Zoho Recruit and would appreciate any insights from fellow users or someone from Zoho. For months, I’ve been receiving daily emails stating that I have reached the maximum workflow custom functions limit.
                                  • Unable to invite contacts

                                    Hi! I'm unable to invite contacts as end-users from my trial account. The green pop-up displays "Invited succesfully" but the email never arrives, nor the re-invitation - even though it's "sucessfully" as well. Tried with several e-mail accounts, even
                                  • Variables in Zoho Mail Signatures defined by Administrator

                                    Good afternoon, I'm looking at the Admin component of Zoho Mail, and I see we have the capability to define signatures for end users. We also have the ability to associate with multiple email addresses. Are we able to use any variables such as [FirstName}
                                  • Invoice status on write-off is "Paid" - how do I change this to "Written off"

                                    HI guys, I want to write off a couple of outstanding invoices, but when I do this, the status of the invoices shows as "Paid". Clearly this is not the case and I need to be able to see that they are written off in the customer's history. Is there a way
                                  • report on lead status history in zoho crm

                                    I have enabled the lead status history. I want to understand how many days a lead is waiting in which stage and the number of leads vs. stage history, like 0 days, 1-4 days, 5 days above, and 10 days above.
                                  • Cannot send a Campaign. No Send or Proceed button

                                    I have built a Campaign. I had to drop Leads and only use Contacts because only one group can sync. But now I do not see any errors but I do not see anyway to proceed with sending the campaign?
                                  • Default Lookup Field Value based on Picklist

                                    How do I change a lookup field value based on another field's value, while creating/editing a record using form? I have a picklist of different types of Loans. For example: PPP, EDIL, Term, etc. When I create a record using the form, if I choose PPP from
                                  • Accounts module not displaying in Campaigns sync

                                    When syncing CRM to Campaigns, I can only sync Leads and Contacts. Accounts module is setup and not sure why I can't select it. I won't be able to make segments for all our email campaigns. What is the resolution?
                                  • Trouble fetching custom fields from Zoho Booking

                                    I'm following the instructions from here : https://help.zoho.com/portal/en/kb/flow/user-guide/app-specific-documentation/articles/zoho-bookings#1_Problem_with_accessing_custom_fields But I can't get this to work. Here is the result of a test booking :
                                  • Zoho Desk - account and contact lookup by phone

                                    Hi team, Does Zoho Desk allow to lookup Accounts and Contacts by phone or not? I am using this endpoint- GET https://desk.zoho.eu/api/v1/accounts/search?phone=987-654-3210 But I am getting this error- { "errorCode": "UNPROCESSABLE_ENTITY", "message":
                                  • Missing Date Field Type Blocking VAT Calculations in Custom Zoho CRM Module

                                    I'm working on a custom VAT calculator within Zoho CRM where I need to store the purchase date of a product and calculate VAT based on that date, since VAT rates can vary over time. However, while creating custom fields, the only available data type is
                                  • Different Page Numbering

                                    I want the page numbers not just 1,2,3... but i,ii,iii,iv,... or even I,II,III,IV.... How can I do this?
                                  • 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
                                  • How to validate Rich Text in Zoho Creator! Urgent!

                                    Hi members, Recently I just started to use Rich Text field. Now I have a requirement where I need to validate to ensure this Rich Text field must contain a value. Meaning must contain something. I use the below script if(input.Rich_Text == null) { alert
                                  • Real-Time Screen Annotation During Zoho Cliq Screen Sharing

                                    Hi Zoho Support Team, Hope you're doing well. We’d like to request the addition of real-time screen annotation tools during screen sharing sessions in Zoho Cliq video calls. 🔍 What We're Looking For: The ability for the presenter—and optionally, other
                                  • Simplify ticket replies with intelligent writing and content analysis tools

                                    Introducing a smarter, faster way to handle ticket responses with generative AI-powered capabilities, now available in the ticket detail view. These enhancements are designed to reduce agent effort, improve clarity, and elevate the overall support experience.
                                  • Zoho Books - Feature Request - Show Custom Template Preview

                                    When using a custom template is would be a great user experience if the custom template could be previewed when viewing the record. I have found that it's very confusing for users, when they see an invoice preview but the out put file is different. Additional
                                  • run a macro on a contact that bounced from crm email merge

                                    how would one run a macro on a contact that bounced from crm email merge? how would i tell zoho to run a macro that SIGNALS said bounced?
                                  • Workflow : Update a multiline text field

                                    Hello, I'm creating a workflow to update a multiline text field. But it looks like I only can format my text as a one-line. How can I format the text to multiple lines ? Thanks
                                  • Search handwriting using sketch card and OCR

                                    Hi It's possible using Sketch Card for handwriting and search them using AI and OCR in Pro edition? Thanks
                                  • Autoresponders in Zoho CRM will be discontinued—transition to Cadences for enhanced engagement

                                    Zoho CRM’s Autoresponder feature will be discontinued by September 30, 2025. If you're currently using Autoresponders to automate email follow-ups, we recommend switching to Cadences, a more powerful, flexible, and multi-channel engagement tool for today's
                                  • Recovering a note

                                    Hi, I accidentally deleted an important academic not from my notebook. Can I recover it? Thanks
                                  • Unable to schedule posts!

                                    Hi everyone, I'm on the free account. I just realised it doesn't give me the options to schedule posts anymore, I can only 'post now'. I don't understand why I can't even see what I scheduled before. Can anyone help? Thanks, Benedetta
                                  • ZUG is Hitting the Road — Across the USA!

                                    We’re bringing the Zoho User Group (ZUG) meet-ups back to various cities across the United States — and we’re more excited than ever to reconnect with our incredible community! Whether you're a seasoned Zoho user or just getting started, this event is
                                  • SPF, Zoho Books, Send from my domain

                                    I am unable to verify my domain through Zoho Books: this is the text record: v=spf1 include:spf.protection.outlook.com include:zohomail.com -all I waited 24 hours already with error: SPF record not found. Contact your domain provider.
                                  • How do I record timesheet invoices generated in Zoho Workerly against a Sales Order?

                                    We have customers who issue us a Purchase Order for an aggregate amount of hourly services, which we invoice against on a weekly, bi-weekly, or monthly basis (contract dependent). For simplicity, let's say the customer PO is for $50,000 (1,000 hours at
                                  • One Place for All Your Automation Needs

                                    All automation settings are grouped under Settings ()> Automation. This helps you find everything related to automation from one place. Under Workflow Rules, Email Alerts, Email Templates, and Webhooks: Use the Projects tab for project-specific settings.
                                  • How Do I Refund a Customer Directly to Their Credit Card?

                                    Hi, I use books to auto-charge my customers credit card. But when I create a credit note there doesn't seem to be a way to directly refund the amount back to their credit card. Is the only way to refund a credit note by doing it "offline" - or manually-
                                  • Next Page