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

    • 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.
    • Recent Topics

    • Automated Shopify adjustment problem. "An inventory adjustment has been created by the system to set the initial stock from Shopify"

      Has anyone noticed issues since the Shopify Sync has been updated recently? If you sync with Shopify, check to see if there are automated adjustments for old products that keep recurring. We have this problem for 6 SKU's that Zoho is doubling the stock
    • Cross module filtering is now supported in CRM

      Editions: All DCs: All Release plan: This enhancement is being released in phases. It is now available in AU, JP, and CN DCs. Help resource: Advanced filters While the feature is being released in phases, you can also request for Early Access. Early Access
    • RSC Connectivity Linkedin Recruiter RPS

      It seems there's a bit of a push from Linkedin Talent Solutions to keep integrations moving. My Account Manager confirmed that Zoho Recruit is a Certified Linkedin Linkedin Partner but does not have RSC as of yet., (we knew that :-) She encouraged me
    • Zoho Analytics - Only show certain data labels

      How do I only show certain data labels on my charts? I have a combo chart with 3 data bars and 1 data line. I only want to show the data label for the data line, not the data bars. How can I do that?
    • Introducing more ways to customize your Bigin forms!

      Greeting, I hope all of you are doing well. We're happy to announce a few recent enhancements we've made to Bigin's forms: You can now effortlessly gather contact and pipeline data. We're also improving the user experience with enhancements to design
    • Apple 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.
    • Create custom rollup summary fields in Zoho CRM

      Hello everyone, In Zoho CRM, rollup summary fields have been essential tools for summarizing data across related records and enabling users to gain quick insights without having to jump across modules. Previously, only predefined summary functions were
    • Google ads - zoho crm integration problem

      dear zoho team we were starting to use google ads integration with zoho crm years ago.  but till April there was an error. we can see GCLID in zoho crm but we couldn't get any information from google ads. (keywords campaign name etc) is there any problem
    • CRM Multiline Field Spacing Bug

      If the text in MultiLine field is changed through client script, the spacing isn't reset and we get a lot of empty space Screen Recording is attached that shows the problem
    • Feedback Setting in Zoho Learn

      Hi everyone, I’ve encountered an issue with the feedback settings while creating quizzes in Zoho Learn, and I’m hoping someone can help me figure out a solution. Feedback Swapping Automatically: When setting up feedback for right and wrong answers, I
    • Post to Bot doesn't work for Clickup extension

      I correctly configurated the extension but i don't received the notifications in my bot when a task has an update. Can you help me?
    • Changing Default PDF Name

      Is it possible to change the default name of a PDF? As of right now, all of my quotes are named 'QT_$QuoteNumber' (i,e: 'QT_19803471298374) - would it be possible to change this to: '$CompanyName - $AccountName - $QuoteNumber' for instance?
    • What takes from the inventory quantity

      There are several options SaleOrders, PurchaseOrders, Invoices... which ones disminish the Inventory quantity of the product? Does the change occurs online?
    • Simple Deluge Script

      Hi. I'm brand new to functions but I'm trying to create a script to convert a date field in Meetings to a written format. For example, instead of 02/05/2025 8:00AM, I'd like to convert it to Wednesday, February 5, 8:00 AM. My Date field is the API Name
    • Show or hide a field based on the value selected in another field?

      Can this be done in CRM? If not and can only happen in Creator is there a way to combine Creator and CRM without paying for 2 accounts? Thanks in advance for your response(s). Moderation Update: I'm locking this post since a solution has been provid
    • Default account for service invoice

      Hello, My client has some invoices for which he has entered a service description rather than using an item.  Is there a way to set the income account on this invoice, or can that only be done by using an item?
    • Extracting data from ZOHO through API

      How can I extract the invoice and bill reports from ZOHO through API? I have to create a dashboard in Power BI and we do use other software too for accounting, so to get all data from different software in single place I need the API.
    • Tip of the week #42- Filter out suspected spam emails before they reach your team's inboxes.

      Are unwanted emails cluttering your inboxes and exposing you to potential threats like phishing and malicious content? The antispam feature in Zoho TeamInbox gives you the perfect solution to keep your inbox organized and secure. By adding trusted email
    • Pivot Chart - Zoho Creator

      In Zoho Creator, I want to enable an edit option within the Pivot Chart itself. Additionally, I want to avoid showing duplicated values for certain columns. For example, I’ve created a month-wise sales report for each product type. The form contains fields
    • Questions about ZohoCRM's portal features

      thanks for the care from you every time. I have a question about ZohoCRM's portal feature. Products are displayed to the customers invited in the standard portal, but the products and prices to be displayed differ depending on the segment of the customer.
    • Contact details when no answer in Chat

      Hello, it would be great to have a feature that when no one is answering in the chat for lets say 60 seconds ... the user gets a meesage to enter his email and we can follow up later. Now we can have only prechat forms ... which can loose potential clients
    • Customer Display Name

      The Customer Display Name defaults to only the first name.  Is there a setting to make it default to display both the first and last name? Thanks, Bryan
    • Introducing LinkedIn Apply Connect for Zoho Recruit

      Attract up to 3x more qualified candidates and hire more efficiently with LinkedIn Apply Connect. Let candidates fill-in job applications without any redirections, gain deeper insights with applicant highlights within Zoho Recruit, and keep candidates
    • How do you apply field validation to a date field?

      We are using Sign for remote e-signature of liability waivers. The signer must enter a date of birth, and if they are a minor their legal guardian must sign for them. However we have had numerous problems with signers returning an invalid date of birth
    • Field Updated based off Call Status

      I'm trying to create a Field Update where: When Call Status is Completed Lead/Contact/Account Description field with the information in the "Outcome Of Outgoing Call" Description field. Once our sales team finishes their calls and they add a description
    • SEO for your Zoho Sites Website

      Join our live webinar to learn how to use Zoho Sites' SEO tools to boost your website's ranking. Our product specialist will demonstrate everything you need to know about optimizing your web pages to make them search engine friendly. Register here for free: https://www.zoho.com/sites/webinars/
    • Automating CRM backup storage?

      Hi there, We've recently set up automatic backups for our Zoho CRM account. We were hoping that the backup functionality would not require any manual work on our end, but it seems that we are always required to download the backups ourselves, store them,
    • Integrating Zoho Creator's Calendar Report with Zoho Calendar as App Calendar

      Hi, it would be helpful if Zoho Creator's Calendar report is integrated into Zoho Calendar as an app calendar.
    • Average Costing / Weighted Average Costing

      Hello fellow maadirs. I understand Zoho Books uses FIFO method of dealing with inventory costing, but do you guys have any plans to introduce average costing? We indians need average costing. It's part of our culture. Please. I beg thee. Thanks.
    • How Good Is Mail Search?

      I am thinking of switching to Zoho hosted mail. I have approx. 1.3G of mail in many hundreds of folders organized hierarchically. It goes up to 7 layers deep. I have to often pull up messages from previous years. Would I be able to search the entire content by using Zoho search? Right now I use an IMAP account. My desktop client is Thunderbird, the server is MailXchange hosted by 1and1. The server allows a multi layer structure, but the search function is useless. Because of that I have to use TB
    • About Domain Redemption Time

      I have a domain that has expired. It is currently in the redemption period, and after I paid the redemption fee as well as the renewal fee(91$). How long will it take for the domain to come back? We have been waiting for two days now and it is a bit
    • Peppol Malaysia API

      Hi Zoho Books, my country Malaysia will going to implement "Peppol" (E-Invoicing), starting 1 Jul 2025 for all businesses. The government intends to provide API for accounting app. The workflow involves creating an invoice from accounting app, triggers
    • Problem when condition with lookup field in Zoho Creator

      this is my code: if input.promotions1 != null { info input.promotions1; } And this my result: when i info input.promotion1 (which is a lookup field), it turn back nothing, so what type of this field is? normally i use the condition: if lookup_field ==
    • Multiple workflows based on stage?

      I am trying to have multiple things happen when I close a deal. First, I would like to send a thank you/coupon email to all deals that are closed. Second, I would like to create connected records in a separate pipeline for certain projects that qualify.
    • Integrate WordPress site as a Knowledge Base for Zoho Desk Suggested Articles

      Dear Zoho Desk Support Team, We'd like to propose a feature enhancement for the Suggested Articles system within Zoho Desk. This feature would allow seamless integration with a WordPress knowledge base, enabling relevant article suggestions for agents
    • Error 403 (forbidden) when using get ticket API on a ticket in a new department

      Hi We use get ticket API and it works well. We created a new department and when we try to use the same API on the tickets from this department, it fails with the error: b'{"errorCode":"FORBIDDEN","message":"You are not authorized to access this resource."}'
    • Custom Buttons

      Is there any way to create a "Custom Button" that would initiate a workflow, or call a custom function, preferably directly from a ticket? In Zoho CRM records can have custom links and buttons that make outside integrations relatively simple.
    • Is there a way to automatically add Secondary Contacts (CCs) when creating a new ticket for specific customers?

      Some of our customers want multiple contacts to receive all notifications from our support team. Is there a way to automatically add secondary contacts to a ticket when our support team opens a new ticket and associates it with an account? This would
    • Issues with GC Integration and Ticket Retrieval in Instant Messaging

      I am using Guided Conversations (GC) within Instant Messaging (IM) channels. When a user sends a message, a ticket is created in Desk, but GC cannot identify which ticket it corresponds to. To address this, I have implemented a workflow rule to rename
    • Set Mandatory Lookup Fields in Ticket Layout

      I added a custom module called 'Site' in the desk. I also added a lookup field 'Site' in the ticket layout. Now, I want the 'Site' field to be mandatory in the blueprint transition. How can I do that?
    • Next Page