Kaizen #7 - URL Encoding while making API Calls

Kaizen #7 - URL Encoding while making API Calls

Welcome to another week of Kaizen. In this post, we will discuss things you need to handle in your code before you start making API calls to Zoho CRM. 

If you have an application that is integrated with Zoho CRM, it will contain the code for making API calls with different request methods—GET, POST, PUT, and DELETE. We will explain the things you need to handle for each of these methods, before you use it to make API calls to Zoho CRM.  

a. GET method

A GET method is used to retrieve data/resource from the resource server. For example, Search Records.

For the GET method, you need to pass data as a parameter in the request URL, and that parameter value has to be URL encoded. 

URL encoding is a way to encode or escape reserved, unprintable, or non-ASCII characters in URLs, and convert them into a secure format. 

Consider the following example, when you try to search a lead record with an email ID(p.daly+demo1@zylker.com).





When this request URL is decoded in our end, it gets converted into:

The '+' character got decoded as 'space'. Because, the '+' character is valid in URL as a substitute for space. Therefore, they have to be encoded or escaped. If not, the URL might be misinterpreted while decoding it. 

Unsafe characters that you need to encode are the following.
  • ASCII Control characters:
    ISO-8859-1 (ISO-Latin) character ranges 00-1F hex (0-31 decimal) and 7F (127 decimal.)
  • Non-ASCII characters:
    Entire “top half” of the ISO-Latin set 80-FF hex (128-255 decimal.)
  • Unsafe characters
    Blank/empty space and " < > # % { } | \ ^ ~ [ ] `
  • Reserved characters when NOT USED for their reserved or defined purposes such as / ? : = &.
Based on your language, you can use the following methods to encode the reserved characters. 

Language
Script
Java
URLEncoder.encode("(p.daly+demo1@zylker.com)", "UTF-8");
Ruby
URI::encode("(p.daly+demo1@zylker.com)")
PHP
Python
urllib.parse.quote("(p.daly+demo1@zylker.com)".encode("UTF-8"))

After encoding, the resultant search query will have the following email ID—p.daly%2Bdemo1%40zylker.com



The corresponding cURL code for this operation is:
curl -X GET \
-H 'Authorization: Bearer 1000.b481413bedf852e81bf591e7ca769de8.85f9671a36047d740216b656c8b3ad4d' 

You can see that the data in the URL is encoded. 

b. POST/PUT method

POST method is used to insert or upload any new resources to the server. For example, Insert Records.

PUT method is used to update an existing resource. This replaces the target resource with the updated content. For example, Update Records.

You can pass the input data for an API call in different ways, based on API requirements. 
  • Sending data as parameter in the request URL
  • Sending data wrapped in a request body
Let us look into each of these methods.  

a. Sending data as a parameter in the request URL 

As mentioned in the earlier section, when you send data as a parameter in  the request URL, it has to be encoded. 

b. Sending data wrapped in a request body

When data is sent in request body, it is secure. There are two different methods  in which you can send data wrapped in a request body, for an API call. Based on  the API requirement, you can choose the appropriate method. 

  • Sending data as raw JSON in the request body 
    In this type, the data is sent as JSON in the request body. Here, you need to add the header 'Content-Type' as 'application/json'. When data is sent as raw JSON, it need not be encoded
  • Sending data as a key-value pair 
    Here, the data is given as key-value pairs. For instance, while you upload an attachment, you need to send the file data, for which you need to make the request with 'Content-Type' as 'multipart/form-data'. Here the data is wrapped in request body. Therefore, it need not be encoded. If the data you have is already encoded, you must use the 'application/x-www-form-urlencoded' content-type and you cannot send file data with this content-type.



Consider the following example of inserting leads.



The corresponding cURL code is:
-H 'Authorization: Bearer 1000.b481413bedf852e81bf591e7ca769de8.85f9671a36047d740216b656c8b3ad4d' \
-H 'Content-Type: application/json' \
 -d '{
    "data": [
        {
            "Company": "Zylker",
            "Last_Name": "Daly",
            "First_Name": "Paul",
            "Email": "p.daly+demo1@zylker.com",
            "State": "Texas"
        },
        {
            "Company": "Villa Margarita",
            "Last_Name": "Bran",
            "First_Name": "Hofstadter",
            "Email": "bran.h+demo2@villa.com",
            "State": "Texas"
        }
    ],
    "trigger": [
        "approval",
        "workflow",
        "blueprint"
    ]
}'

You can see that the data is not encoded.

c. DELETE method

DELETE method is used to delete a resource at a particular location. For example, Delete Records.

URL encoding for the DELETE method is the same as the GET method. Consider the following example of deleting leads. 

Encoded request URL:



We hope you found this post useful. Keep a tab on this series for more exciting topics!

Reach out 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


          All-in-one knowledge management and training platform for your employees and customers.






                                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 #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.
                                                                • Kaizen #226: Using ZRC in Client Script

                                                                  Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In this
                                                                • Kaizen #222 - Client Script Support for Notes Related List

                                                                  Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore how
                                                                • 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


                                                                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

                                                                                                                    • Why don't Zia agents support file uploads?

                                                                                                                      I am trying to build a Zia Agent that allows uploading of a PDF file and uses the GLM5 model to process it and extract information. But agents.zoho.com has no way to enable file uploads on the agent. Additionally, GLM5 based agents keep outputting their
                                                                                                                    • Re-Apply SLA When Ticket Reopened from Closed Status?

                                                                                                                      If you have an SLA applied, timers are deactivated when going to "On Hold" status type and reactivated when going back to an Open status type. What we discovered is when a customer replies to a closed case and it reopens, the SLA is not applied and timers
                                                                                                                    • Zoho Forms - Failed CRM Sync Improvement

                                                                                                                      I'd like to suggest an enhancement to the Zoho Forms and Zoho CRM integration. Currently, once a form entry has been submitted, there is no simple way to push that individual entry to CRM again if needed. Before anyone mentions it, I am aware that the
                                                                                                                    • Lead score decay timing and excluding specific campaigns from scoring

                                                                                                                      Hi team, I have two quick questions about lead scoring: 1. When does a lead's score start going down? Like, after how many days of no activity does the score begin to drop? 2. Is there a way to stop certain campaigns from adding points to a lead's score?
                                                                                                                    • How to show product cards in your chatbot

                                                                                                                      Hey everyone, If you are using Guided Conversations to help customers find products, you have probably run into this problem: the bot gives customers a list of options, but they still have no idea which one to pick. There will be no images, no specs,
                                                                                                                    • "Make online" not clearing previously downloaded files from disk

                                                                                                                      I downloaded a large folder via "Make offline" so I could copy it to another location. This worked. When I was done I hoped that "Make online" would restore it to the previous state where those files are not stored locally in TrueSync. This did not work—Finder
                                                                                                                    • Importing Tasks

                                                                                                                      Few suggestions that would make creating project templates more efficient.   1. Having the ability to import tasks from a spreadsheet within the Project Template Task section.  You can do this when creating a "new project." 2. When importing Tasks from a spreadsheet, to be able to associate a milestone to a tasklist, just as I can associate a tasklist to a task.  This would alleviate a very tedious, time consuming process. 3. Another feature that would be very helpful is rather than a start and end
                                                                                                                    • GSTIN Public Search API

                                                                                                                      Does zohobooks have an api using which i can search GST numbers and get their details?
                                                                                                                    • Zoho Books | Product updates | April 2026

                                                                                                                      Hello users, Welcome to our April 2026 product updates roundup! Highlights include profit margin for sales transactions, insights in reports, recording deposits from undeposited funds in banking, and faster production workflows with improved assembly
                                                                                                                    • Deleted User Emails

                                                                                                                      I need to delete a user as I need to re-use their license, but I'd like to keep all their emails that are attached to various contacts in the CRM. Their emails are hosted externally on an M365 license. Anyone any idea how best to engineer this? TIA
                                                                                                                    • Quotes Module - import data

                                                                                                                      Hello Zoho, is it possible to import Quotes records? I was trying and i have no results. Raport shows no data imported. Could you help me please how to do it?
                                                                                                                    • Spell Check Red Underlines Keep Appearing Even After Disabling

                                                                                                                      Hello Zoho Support, I'm facing an issue in Zoho Writer where red spell-check underlines keep appearing even after I disable Spell Check. I have already: Turned OFF Spelling Errors Turned OFF Grammar Turned OFF Writing Quality Turned OFF browser spell
                                                                                                                    • Its 2022, can our customers log into CRM on their mobiles? Zoho Response: Maybe Later

                                                                                                                      I am a long time Zoho CRM user. I have just started using the client portal feature. On the plus side I have found it very fast and very easy (for someone used to the CRM config) to set up a subset of module views that make a potentially extremely useful
                                                                                                                    • Truco del mes: Zoho Desk - Cómo mostrar tarjetas de producto en tu chatbot

                                                                                                                      ¡Hola a todos! Si utilizas Conversaciones Guiadas (Guided Conversations) en Zoho Desk para ayudar a los clientes a encontrar productos, probablemente te hayas encontrado con este problema: el bot ofrece una lista de opciones, pero los clientes siguen
                                                                                                                    • Cliq iOS can't see shared screen

                                                                                                                      Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? Regards
                                                                                                                    • Retail Payment Receipt

                                                                                                                      Hi, So "payment receipts" have a "Retail" template for thermal printers, but the template is configured at A4 paper size!!! How is this retail guys? On the other hand, Invoices have 3 Retail templates which have 3 and 4 inch paper size, perfectly fitting
                                                                                                                    • Assign default Location + warehouse to Customer / Vendor

                                                                                                                      Hello there. With the introduction of Locations I'm having to enter the warehouse for every single transaction which is getting really tiring and causes errors (easy to fix, but still). Does anybody know if there's a way to assign a default Location and
                                                                                                                    • SalesIQ : Allow Operators to Manually Set Company Names in Visitor Info

                                                                                                                      Hi SalesIQ Team. We have identified an issue where the Company name displayed in Visitor Info is sometimes incorrect or not displayed at all. Currently, there is no way for operators to manually edit or specify the company a visitor belongs to. I understand
                                                                                                                    • How to charge Convenience fee OR payment gateway charges to the end client who is paying the invoice?

                                                                                                                      Hello, I am creating this topic after having discussions with various sets of users and have understood that with people moving more and more to digital payments, it is important for the client to enable the "Convenience fee" kind of scenario. I have
                                                                                                                    • 404 error at checkout

                                                                                                                      Our customers are getting a 404 error at checkout. Anyone else with the same problem?
                                                                                                                    • Enhancement in Zoho CRM: Introducing New Return Types for String Fields Based on Character Length

                                                                                                                      Dear Customers, We hope you’re well! In Zoho CRM, formula field with string return type is used in various scenarios where text is involved like concatenating customers’ first and last names, trimming characters from texts, performing find and replace
                                                                                                                    • BUG and HANGUP - Add Row with Fields DOUBLES the amount of rows instead of Adding Just 1 Row

                                                                                                                      As it says in the title, there is a bug with forms generated with Zoho Writer where the Add Row With Fields ends up DOUBLING the amount of rows instead of Adding just 1 row.
                                                                                                                    • Import and Export of website.

                                                                                                                      Hi, i have raised this ticket regarding challenges i am facing while importing a website on zoho sites. I have created my website on Squarespace and now i want to move it to zoho sites so i want to know what i am supposed to do whats the correct step
                                                                                                                    • Approval Escalation based on time.

                                                                                                                      How can I configure a multi-approval in Zoho creator. I want to have 2 approvers, say team lead and line manager. I want prices less than 50 to go to the team lead, otherwise they should to the line manager. Also if the price is 50 but the team lead takes
                                                                                                                    • Zoho Analytics "Esc" key problem

                                                                                                                      I frequently use the Escape (Esc) key while building dashboards, reports, and writing SQL queries. Since the recent updates to Zoho Analytics, the Esc key no longer behaves as expected. When writing SQL queries, pressing Esc to dismiss a suggestion now
                                                                                                                    • All new Address Field in Zoho CRM: maintain structured and accurate address inputs

                                                                                                                      Availability Update: 29 September 2025: It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition exclusively for IN DC users. 2 March 2026: Available to users in all DCs except US and EU DC. 24
                                                                                                                    • Error when subscribing to any iCal feed in Group Calendar

                                                                                                                      When I try to add any iCal URL via Settings → Calendar → Calendars → Group Calendars → Manage → Subscribed by Group, Zoho pops up an ‘Internal Server Error’ and nothing is added in the ‘Subscribed by Group’ list. But - the feed then appears under my personal
                                                                                                                    • Record Limit on Report

                                                                                                                      I have set up a report that I'm putting on a "page". I have filters set up to only show the records with deadlines in the next 45 days. But I only want the report to show the first 3 records (and if possible have a pagination option at the bottom to access
                                                                                                                    • Problem with the blueprint flow.

                                                                                                                      Scenario: 3 departments in a single environment: A-B-C agents from department 1 D-E-F agents from department 2 G-H agents from department 3 Since we've been using Zohodesk (2023), agents can assign tickets to the correct department using the blueprint
                                                                                                                    • Zoho ERP | Product updates | June 2026

                                                                                                                      Hello users, We launched Zoho ERP on January 23, and since then, our goal has been to help businesses streamline and manage their operations with greater efficiency, flexibility, and control. Since the launch, we've continued to enhance the platform every
                                                                                                                    • Kaizen #125 Manipulating Multi-Select Lookup fields (MxN) using Zoho CRM APIs

                                                                                                                      Hello everyone! Welcome back to another week of Kaizen. In last week's post in the Kaizen series, we discussed how subforms work in Zoho CRM and how to manipulate subform data using Zoho CRM APIs. In this post, we will discuss how to manipulate a multi-select
                                                                                                                    • Zoho CRM upload files error

                                                                                                                      Since today, we have been experiencing issues with uploading photos to opportunities. The message indicates that the storage is full, but as far as I can see, there is still plenty of space available. Could there be an issue or a bug?
                                                                                                                    • Mise à jour de Zoho Books – France

                                                                                                                      Chers clients, Merci pour votre patience et votre soutien continu. Avec les évolutions réglementaires à venir en France nous introduisons de nouvelles fonctionnalités dans Zoho Books pour les clients français. Ces mises à jour ont été conçues pour répondre
                                                                                                                    • Please Make Zoho CRM Cadences Flexible: Allow Inserting and Reordering Follow-Up Steps

                                                                                                                      Sales processes are not static. We test, learn, and adapt as customers respond differently than expected. Right now, Zoho Cadences do not support inserting a new step between existing follow-ups or changing the type of an existing primary step. If I realize
                                                                                                                    • WhatsApp Calling Integration via Zoho Desk

                                                                                                                      Dear Zoho Desk Team, I would like to request a feature that allows users to call WhatsApp numbers directly via Zoho Desk. This integration would enable sending and receiving calls to and from WhatsApp numbers over the internet, without the need for traditional
                                                                                                                    • Introducing Custom Columns in Forecasts in Zoho CRM

                                                                                                                      Hello all, Forecasts in Zoho CRM help sales representatives, managers, and business stakeholders evaluate performance and plan future sales activities. While standard metrics such as Target, Achieved Amount, and Pipeline Amount provide a baseline view,
                                                                                                                    • Let's bring Manufacturing Resource Planning (MRP), Material Requirement Planning (MRP), and Production Planning/Management module / feature in Zohobooks

                                                                                                                      Let's bring Manufacturing Resource Planning (MRP), Material Requirement Planning (MRP), and Production Planning/Management module / feature in Zohobooks
                                                                                                                    • Will I see emails sent via campaigns in CRM?

                                                                                                                      It would be useful for people to be able to see emails sent via campagins in Zoho CRM is that possible?
                                                                                                                    • Zoho ZUGs Meetups 2026 en España: Descubriendo nuevas posibilidades con Zoho

                                                                                                                      ¡Hola, Español Zoho Community! Hemos celebrado una nueva edición de los Zoho User Groups (ZUGs) en España (Madrid, Barcelona & Valencia), una excelente oportunidad para reunirnos, formarnos y descubrir nuevas formas de sacar más partido a nuestras herramientas
                                                                                                                    • What is MCP and How Does It Connect to Zoho Invoice?

                                                                                                                      If you've ever wished you could just tell your invoicing software what to do, without clicking through menus, pulling up reports manually, or switching tabs every five minutes, that's exactly what the Zoho MCP server is built for. MCP stands for Model
                                                                                                                    • Next Page