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

      • Kaizen #126 - Circuits in Zoho CRM - Part 1

        Hello everyone! Welcome back to another week of Kaizen! Today, we will discuss an exciting topic—Circuits in Zoho CRM. For starters, we will discuss what Circuits are, how beneficial they are for businesses, different views of a Circuit, and the different
      • Create customized SLAs for your customer base with support plans

        Managing customer expectations, prioritizing critical issues, and resolving customer inquiries on time is quite a juggle. Without a clear timelines or defined priorities, a support team may struggle with delays in response, SLA violations, and pending
      • Zoho Flow or Schedules

        I have a process where we text our leads 7 times over a 14 day with different content for each text. I created one flow in Zoho Flow to do this, but wondering if there is a more efficient way to accomplish this via Schedules. It goes on for 6 more times
      • Free webinar: Zoho Sign 2024 wrap-up - Everything that is new and has changed

        Hello, Are you looking up to catch up on all the updates made to Zoho Sign in 2024? Or are you still figuring out how you can use Zoho Sign better to get business paperwork done more efficiently? If so, we invite you to join us this Thursday, December
      • Send Whatsapp with API including custom placeholders

        Is is possible to initiate a session on whatsapp IM channel with a template that includes params (placeholders) that are passed on the API call? This is very usefull to send a Utility message for a transactional notification including an order number
      • How to Customize Task Creation to Send a Custom Alert Using JavaScript in Zoho CRM?

        Hello Zoho CRM Community, I’m looking to customize Zoho CRM to send a custom alert whenever a task is created. I understand that Zoho CRM supports client scripts using JavaScript, and I would like to leverage this feature to implement the alert functionality.
      • Workflow - Execute Based on Date

        Hello, I have trouble understanding the documentation for Execute Based on Date or Date Time Field's Value. I want to send an email every time I have a Case opened for more than three days with its status unchanged. I set : This rule will be executed 3 days after [date].  Condition : Status is [New]. Instant Action : Send an email notification. However, I'm not sure I follow this part of the documentation: "For all the records matching the rule criteria, rule will be triggered either monthly or yearly
      • Can we set a BCC address as default to show while sending emails?

        Two things inside ZohoCRM are annoying me because it's a repeated work. First one is that I always need to click manually to add the BCC field while sending an email to a lead. Can we set a default address so when I click to send a new email the BCC address
      • Client Script - mapping data from different module

        Dear ZOHO Team Firstly I need to describe the need - I need to have data from Contacts module based on lookup field - the 5 map limit is not enough for me because I have almost 20 fields to copy So I have decided to make a Customer Script - and from unknown
      • Make collecting payments from your customers in Bigin easier with payment links

        Greetings, Efficient payment collection is crucial for business success. Bigin already helps your businesses manage and sell products effectively, but we can further enhance this by making payment collection easier. This integrated payment feature lets
      • Zoho Creator Upcoming Updates - December 2024

        Hi all, We're excited to be back with the latest updates and developments on the Creator platform. Here's what we're going over this month: Deluge AI assistance Rapid error messages in Deluge editor QR code & barcode generator Expandable RTF and multi
      • Basic Price List Functionality Still Missing

        I am having a problem with the most simple imaginable pricing scenario - you buy cheap, add profit, then sell high. Or in less simplistic terms: business buys a product at a given cost, then adds predetermined percentage markup, and finally sells that
      • How do I hire employees????

        Hi! I own a bookkeeping company, where a few of my clients use Zoho Books as their accounting platform . I started utilizing Zoho Practice to work on the books of my Zoho clients, some have Zoho One and some have Zoho Books plans. I just hired an employee,
      • Advanced Framing Techniques

        I'm a construction professional passionate about optimizing building practices, and I want to share my insights on Advanced Framing Techniques with this forum. When I first learned about these methods, I was amazed at how much efficiency they bring to
      • Automate data upload process like reports

        I'll start with the end in mind.  I want to basically keep certain creator tables updated with data that are in a sql database/tables in our office (employees, active jobs, employee positions) so I can reference that data and not have to duplicate it by hand every time someone adds a new job or employee in the office desktop software.  Here are some thoughts I had about how to do this, but am unsure as to whether any of them are actually possible and how to go about it from there: Is there any way
      • Greylisted, try again after some time

        Can you check my ip, i send to duyna@vietlinkjsc.vn but have an error; my ip is 112.213.94.12 Here is log: 2018-01-09 09:40:29 H=mx.zoho.com [204.141.32.121] SMTP error from remote mail server after RCPT TO:<duyna@vietlinkjsc.vn>: 451 4.7.1 Greylisted, try again after some time 2018-01-09 09:40:32 H=mx2.zoho.com [204.141.33.55] SMTP error from remote mail server after RCPT TO:<duyna@vietlinkjsc.vn>: 451 4.7.1 Greylisted, try again after some time 2018-01-09 09:40:32 duyna@vietlinkjsc.vn R=lookuphost
      • Zoho Sheet Custom function column showing Error #EVAL!

        Hello I have a custom function in Zoho Sheet developed to convert a date time from one time zone to another. The custom function takes date and time columns and then using subHour( ) converts the time to PST time. However, though the custom function works,
      • Clear String field based on the value of other field

        Hello everyone, We would like to be able to clear a string field (delete whatever has been written and make it empty) when another field (picklist) is changed to a specific value. While I can empty other types of fields, I noticed that I can't do this
      • Emails linked to Deal

        Hello everyone, I’d like to ask a question to see if someone can help me out. We are requesting availability from suppliers by sending emails directly from the Opportunity. These emails we send are logged within the Opportunity; however, when we receive
      • How to transfer all my mails from Zoho to Gmail or Office 365

        is there any option to move my emails from zoho to gmail or office 365. i would like to export more than 25k emails from zoho to office 365 or gmail. can anyone help me to guide properly. this will help me to access my emails easily i have both account and can easily  do it with office 365 or gmail. i want two options. direct from zoho to office 365  or exported eml files from zoho to gmail. please suggest me both if possible 
      • Inquiry Regarding Image Display Issue in Campaign Duplication

        We are currently using Zoho Campaigns for email distribution to our clients. I would like to inquire about an issue we encountered. When duplicating a previously created and sent campaign from the "All Campaigns" section, the images used in the header
      • New integrations for Bigin: Zoho Sign, SalesIQ, and Marketing Automation

        Greetings, We're excited to share new integrations that make Bigin more powerful and useful for your business! Zoho Sign for Bigin Zoho Sign now integrates seamlessly with Bigin, enabling you to sign, send, and manage contracts or agreements without leaving
      • Add multiple users to a task

        When I´m assigning a task it is almost always related to more than one person. Practical situation: When a client request some improvement the related department opens the task with the situation and people related to it as the client itself, the salesman
      • What is Attendee Status 0 and 1?

        Hi there, I recently stumbled upon the API to get the attendee list and in the return value, there is a parameter called "status", and 0 supposed to mean not_attending, and 1 means attending. I cannot find this representation anywhere in the attendee
      • How to add a Data Updated As Of: dynamically in text?

        I need to add a "Data Updated As Of" in the dashboard to show when was the last date the data was updated. I tried to create a widget but it does not look really good, see below. Is there a way I can do this through the text widget and update it automatically
      • ZOHO BackStage

        How to get list of events, using ZOHO BackStage APIs. Is it possible OR not?
      • Email with attachments saving attachments into Zoho CRM from Zoho Mail

        Hi, I get a lot of emails from prospective clients asking if we would bid their project. Those projects usually have many documents associated with them that I link to.  I would like to have those documents be saved as an attachment in my Potential or Contact or Account. I don't see a way to do that that isn't multi-step. As of now I do the following: 1.) Open email 2.) If email sender isn't in my Zoho CRM database I enter them creating a Potential 3.) I download the attachment and save it to a different
      • Directly Edit, Filter, and Sort Subforms on the Details Page

        Hello everyone, As you know, subforms allow you to associate multiple line items with a single record, greatly enhancing your data organization. For example, a sales order subform neatly lists all products, their quantities, amounts, and other relevant
      • Blueprint - Field Validation Criteria (During)

        When setting validation criteria elsewhere in Zoho, or even workflow criteria etc., there are Is Empty and Isn't Empty options.  Within the Field Validation Criteria within Blueprint, those options aren't available.  Is there a particular reason for this? 
      • Request For Quotation (RFQ) module

        Hello, Do you have any plans to implement a RFQ module in to ZOHO Inventory? I would like to chose items that I require a price for, select a number of different suppliers to e-mail and have them submit there pricing online. I would then like to see a
      • How to Customize Task Creation to Send a Custom Alert Using JavaScript in Zoho CRM?

        Hello Zoho CRM Community, I’m looking to customize Zoho CRM to send a custom alert whenever a task is created. I understand that Zoho CRM supports client scripts using JavaScript, and I would like to leverage this feature to implement the alert functionality.
      • Lookup Fields not Converting

        I manage holiday properties. I have a lookup to the Accounts (Properties) in the Leads module. The lookup is connected to the property address field. When I convert it the lookup field does not update in Deals, although the property address does. There
      • Zoho Meeting iOS app update - Join breakout rooms, access polls, paste links and join sessions, in session host controls

        Hello, everyone! In the latest iOS version(v1.7) of the Zoho Meeting app, we have brought in support for the following features: Polls in meeting session Join Breakout rooms Paste link in join meeting screen Foreign time zone in the meeting details screen.
      • Calculate hours between 2 date/time fields

        Hi, Does anyone know if it is possible to get the number of hours between 2 date/time fields in a zoho crm custom function? Thanks, Michael
      • External ID validation.

        I added an external ID field as below in one of my custom modules: When creating records via the API using some value (eg: 762115b2-097e-43b2-bdba-f3924a5371a6) for this field, it works without any problem. I can create and even see the records on the
      • Sales Order, what are the statuses under Confirmed and Closed

        Hi, I have to build a workflow in Deluge which should be triggered when Sales Order status is Confirmed or Closed. But these 2 states don't exist when you fetch a sales order. Which of the statuses are considered as Confirmed or Closed ? Here is a list
      • CRM x WorkDrive: File storage for new CRM signups is now powered by WorkDrive

        Availability Editions: All DCs: All Release plan: Released for new signups in all DCs. It will be enabled for existing users in a phased manner in the upcoming months. Help documentation: Documents in Zoho CRM Manage folders in Documents tab Manage files
      • Not able to change colors help center

        Hi. How can I change the orange color in the help center? You can change everything besides this font color And how can I remove the part on the bottom?
      • Remove Address from credit card payment

        I would like to remove the need to add address when paying by credit card. I only want the customer to have to add their credit card details.
      • Copy Widget to another Dashboard

        I can see the option to clone a widget to the same dashboard but is it possible to copy it to another dashboard?
      • Next Page