Kaizen #134 Manipulating Rich Text Field (RTF) using Zoho CRM APIs

Hello everyone!

Last week, we discussed Deciding on the type of applications: Self-client or Server-based? This week, we will discuss the Rich Text Field (RTF) and how we can manipulate RTF using Zoho CRM APIs.

In this post,

What is a Rich Text Field (RTF)?
Use case
Rich Text Field creation in a module using the Create Custom Field API
Adding values to the RTF using the Insert Records API
Fetch complete data of RTF using the GET - Rich Text Field API
Updating Rich Text Field using the Update Records API
Deleting RTF using the Delete Custom Field API
RTF using the COQL API
RTF using Bulk APIs

1. What is a Rich Text Field?

The Rich Text field is the preferred choice when there is a need for formatted text and a larger character limit. It can accommodate up to 50,000 characters, including HTML elements that are generated when the text is formatted, making it ideal for entries that require styling and organization, such as product descriptions or detailed client communications. Although tooltips can be added to improve user interaction, the rich text field does not support encryption or mandatory input settings.

Using rich text can improve the visual appeal of your information by providing different font styles, colors, and highlights. This allows for effective communication of important details. Bullet points and numbered lists can enhance readability, while bold, italics, or underlined texts can emphasize crucial information. Increased and decreased indents can help organize data, and the strikethrough feature can easily indicate changes or updates.

2. Use case

Consider Zylker, an org that uses Zoho CRM as their sales management system to store reports or feedback on its employees' sales performance report, total revenue, sales breakdown by product, key achievement, challenges faced, action plan, and to-do lists. These are stored in the multi-line field's rich text format type for better visuals and to identify the important information easily.

Let us see how to create RTFs using APIs, and how to access or update RTF using different available APIs. Note that the Rich Text type of multi-line field is supported from version 6.

3. Rich Text Field creation in a module using the Create Custom Field API

To create a rich text field in a module, first know the module's API name using the GET - Modules Metadata API, then create a custom RTF field in that module.

Request URL to create Rich Text Field :

{api-domain}/crm/v6/settings/fields?module=Employees

Request Method : POST

Sample Input :

{
"fields": [
{
"field_label": "Feedback",
"data_type": "textarea",
"length": 50000,
"textarea": {
"type": "rich_text"
},
"tooltip": {
"name": "static_text",
"value": "employee's feedback"
}
}
]
}

4. Adding values to the RTF using the Insert Records API

To add values to the created rich text field, you should know its API name.

Using the api_name of the Employees module, make a GET - Fields metadata API call to get the list of fields (along with their api_name) in the Employees module. Search for the field in which you need to add values to the Rich Text Field. In our case, it is Feedback.

Request URL : {api-domain}/crm/v6/Employees

Request Method : POST

Sample Input :

{
"data": [
{
"Company": "Zylker",
"Name" : "Patricia Boyle",
"Email": "patricia@zylker.com",
"State": "Texas",
"Feedback": "Sales Performance Report Salesperson Name: Patricia Reporting Period: Q1 2024 Total Sales Revenue Generated: $250,000 Sales Breakdown: <ul style=\"list-style-type:disc;list-style-position:inside;padding-inline-start:20px;\"><li style=\"color:rgb(51, 51, 51);\">Product A: $100,000</li><li style=\"color:rgb(51, 51, 51);\">Product B: $80,000</li><li style=\"color:rgb(51, 51, 51);\">Product C: $70,000</li></ul> Key Achievements: <ul style=\"list-style-type:disc;list-style-position:inside;padding-inline-start:20px;\"><li>Exceeded sales targets for Product A by 20%.</li><li style=\"color:rgb(51, 51, 51);\">Secured 5 new clients for Product B, contributing to a 25% increase in sales.</li><li style=\"color:rgb(51, 51, 51);\">Closed a high-value deal for Product C with a revenue of $50,000.</li></ul> Challenges Faced: <ul style=\"list-style-type:disc;list-style-position:inside;padding-inline-start:20px;\"><li style=\"color:rgb(51, 51, 51);\">Market competition intensified, resulting in longer sales cycles.</li><li style=\"color:rgb(51, 51, 51);\">Difficulty in accessing decision-makers for key accounts, leading to delays in closing deals.</li><li style=\"color:rgb(51, 51, 51);\">Some clients expressed concerns about pricing, requiring additional negotiation efforts.</li></ul> Action Plan: <ol style=\"list-style-type:decimal;list-style-position:inside;padding-inline-start:20px;\"><li style=\"color:rgb(51, 51, 51);\">Targeted Marketing Campaigns: Launch targeted marketing campaigns to increase brand visibility and attract potential clients.</li><li style=\"color:rgb(51, 51, 51);\">Enhanced Networking: Strengthen networking efforts to establish connections with decision-makers and key stakeholders.</li><li style=\"color:rgb(51, 51, 51);\">Client Retention Strategy: Implement a client retention strategy to address pricing concerns and ensure customer satisfaction.</li></ol> To-Do Lists : Continued focus on building strong client relationships, identifying new opportunities, and leveraging resources effectively to drive further sales growth in the upcoming quarters."
}
]
}

Notes:

If you enter incorrect API names for fields, the system will skip them and the record will be created successfully, but the values won't be added. This rule applies to RTF too.
When using the Insert Records API for bulk records creation and the Update Records API for bulk records update, you can add up to 50,000 characters to RTFs in each record.
For details on supported HTML tags and their attributes, refer to the help document.

The below GIF shows the result of the above input in the UI.

When you add values using HTML tags to the RTF via API, the input will be transformed into formatted data.

5. Fetch complete data of RTF using the Rich Text Field API

The Rich Text Field supports up to 50000 characters. Using the GET - Records API, you can fetch only the first 500 characters of the rich text field ('Feedback' in our case) in the response. If the @has_more property in the GET- Records response is true for the Rich Text Field (RTF) value, it indicates that the RTF contains more than 500 characters.

To fetch the entire data, we have introduced the GET - Rich Text Field API in V6, enabling the retrieval of complete data from rich text fields.

Below Sample shows how to fetch full data :

Request URL : {api-domain}/crm/v6/Employees/5725767000002594018/actions/fetch_full_data

Request Method : GET

Response :

6. Updating Rich Text Field using the Update Records API

Updating a rich text field doesn't require any special steps. It is similar to the process how we update other fields in a record, using the Update Records API.

7. Deleting RTF using the Delete Custom Field API

General notes :

Rich text fields are not supported in subforms, List View, Kanban View, Canvas View, Sheet View, Related Lists, Lookup popup, global search, filters and criteria, formula fields, report export, and integrations.
Rich text fields are not supported in the Search API.
Rich text fields are supported for importing and exporting records, using the Bulk APIs. The data will be exported as HTML content. For example, Patricia will be exported as Patricia.

8. Rich Text Field using the COQL API

Retrieve the Rich Text Fields from a module through a COQL query. Note that RTFs cannot be used in the criteria. Similar to the GET - Records API, the COQL API response fetches up to 500 characters of the RTFs. To fetch its complete data, use the GET - Rich Text Field API.

Request URL : https://www.zohoapis.com/crm/v6/coql

Request Method : POST

Sample Input :

{
"select_query":"select 'Feedback' from Employees where Company is not null"
}

Response :

9. Rich Text Field using Bulk APIs

Bulk Read API :

Bulk Read API allows you to fetch a large set of data i.e., you can fetch a maximum of 200,000 records in a single API call. You can export complete data of rich text fields in a module. Note that RTFs cannot be specified in the criteria.

Request URL: https://www.zohoapis.com/crm/bulk/v6/read

Request Method: POST

Sample input :

{

"callback": {

"url": "https://www.example.com/callback",

"method": "post"

"query": {

"module": {

"api_name": "Employees"

"file_type": "ics"

}

The Bulk Read API is an asynchronous API, the response will not be available instantly; the bulk read job is scheduled. Once the job is completed, it'll be notified in the callback URL. The records are available in a downloadable CSV file or ICS file (for events).

Below is a sample downloaded CSV file:

Unlike the GET - Records API, the Bulk Read API fetched the RTF's complete data.

See our Bulk Read API documentation to know how to view the status of the scheduled job and download the file in detail, along with more sample requests and responses.

Bulk Write API:

Bulk Write API allows you to insert, update, or upsert a large set of data. In the CSV file module, using the Bulk Write API, you can add up to 50000 characters to the RTFs for each record in a row.

Prepare your CSV file

The Bulk Write API only accepts a CSV file compressed into a ZIP file as input.

Below picture represents values added to the rich text field:

Please ZIP the CSV file once you add values to the Rich Text Field.

Upload your CSV file :

This involves making a POST API call, with the ZIP file containing the required data.

Headers

Header Name	Description
feature	bulk-write
X-CRM-ORG	Your zgid which you get from the Organization API

Request URL: https://content.zohoapis.com/crm/v6/upload

Request Method: POST

Create a bulk write job :

Request URL : {{api-domain}}/crm/bulk/v6/write

Request Method : POST

Sample Input for bulk insert :

{
"operation": "insert",
"ignore_empty": true,
"callback": {
"url": "https://example.zoho.com/test",
"method": "post"
},
"resource": [
{
"type": "data",
"module": {
"api_name": "Employees"
},
"file_id": "5725767000002613001",
"file_names": [
"Rich.csv"
],
"field_mappings": [
{
"api_name": "Name",
"index": 0
},
{
"api_name": "Feedback",
"index": 1
},
{
"api_name": "Company",
"index": 2
}
]
}
]
}

Refer to our Bulk Write API help document and get more information on how the Bulk Write API works, how to prepare your CSV file, and how to upload your CSV file, and how to check the job status.

We trust that this post meets your needs and is helpful. Let us know your thoughts in the comment section or reach out to us at support@zohocrm.com

Stay tuned for more insights in our upcoming Kaizen posts!

Cheers!

Previous Kaizen Post :

Kaizen #133 - Deciding on the type of applications: Self-client or Server-based?

Additional Reading :

API Help Documentation : Rich Text Field API
Kaizen Series
Knowledge Base Documentation

Join us for our upcoming Zoho CRM Developer Series: Zoho CRM APIs, where you can explore more about Zoho CRM APIs. Register Now!

Topic Participants
Subramanian K
Vigneshwaran K

Sticky Posts
Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI
Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over the
Kaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved
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

Recent Topics
What is Zoho Marketing Plus?
As if there wasn't enough confusion with SalesIQ, CRM, Campaigns and Marketing Automation, now we have Marketing Plus too. Can somebody from Zoho please give us a comparative list of features that are in Marketing Plus compared to what's in Marketing
I didn't receive my domain verification mail
I didn't receive my domain verification mail
Creating a new deal with specific layout and pipeline
I am trying to create a button which creates a new deal for a particular account. It needs to be assigned a specific layout and pipeline. It seems like it should be really simple but I've been struggling to get this to work all day, can anyone help?!
Announcing New Features in Trident for macOS (v.1.21.0)
Hello everyone! Trident for macOS is here with interesting features to elevate your workplace communication and productivity. Let's take a quick look at them. Get better visibility for concurrent events. Quickly compare and manage simultaneous events
Modifying Product Details
I am in the process of setting up new products in Zoho Commerce and have encountered a few problems: 1) Tabs It seems that Product Details pages do not have the ability to create Tabs. eg: https://www.thedebugstore.com/tp240141-aardvark-usb-i2c-spi-host-adapter-total-phase.html
Zoho Commerce B2B
Hello, I have signed up for a Zoho Commerce B2B product demo but it's not clear to me how the B2B experience would look for my customers, in a couple of ways. 1) Some of my customers are on terms and some pay upfront with credit card. How do I hide/show
Creating a custom CSV file using deluge script/
I have an application I have developed and the client wants us to place an export file in csv onto an ftp server daily. Now I don't see au options in creator to change the separator to anything else. The client wants the separator to be the pipe symbol "|" I think i would be able to create schedule with some code to create the appropriate data in a string using deluge script but I haven't seen any functionality that would allow me to deposit that data as a file anywhere or attach it to an email
How can I get a nested value attributes inside a key par?
Hello! Im getting the following output when reviewing a record I am after. I am trying to put some conditions based on a data value that is inside another data. For example, lets grab the below output. Info {"Account_Name":{"name":"Liberty Construction
Invoices not arriving and mail server settings
I am having an issue where some clients are not receiving invoices. I have configured Zoho Books to send on my behalf and configured the appropriate SPF, DKIM and DMARC settings on my mail server and tested these as working. I get the CC'd copies so I
Multi Line Text Character Limit
I want to export my Help Center articles but I realized that the text in the Answer column is being cut off. I'm guessing there is a character limit for multi line text fields. How can I get around this?
Emails bouncing to Hotmail / Outlook.com
Today I have seen multiple emails bouncing all to Hotmail and outlook.com mailboxes, all other emails are being delivered. Is it just me or is this a widespread issue with Zoho Books ? Bounce Reason : uncategorized-bounce
Be careful if you want to purchase zoho one
Hi, just to add one more complain to the other similar complains. When I purchased zoho one, Divith, my account manager told me (by email) that I would be able to keep different emails that I have inside the company (contact, privacy, etc.). During the
Schedule Timeout 5 minutes vs. stated 15 minutes
I am running into a function run timeout error after 5 minutes for my schedules. The Functions - Limits documents states it should be 15 minutes: Functions - Limits | Online Help - Zoho CRM. What should it actually be? Due to the 5 minute timeout, I'm
Importing invoices in bulk using the xls file template - still posting as draft - Is there a way to skip "mark as sent" and post it directly?
Hello everyone, as the title say, is there a way that when I upload from the template file, it will post automatically? I tried changing the "Invoice Status" from draft to approved but it is still appearing as draft and is making me go to invoices so
How to set Sales Order Payment Terms when creating a Sales Order via the Zoho Books API
I am creating Sales Orders via the Zoho Books API. I would like to set the Payment Terms to a particular value from the list of allowed values. Is that possible? I was able to get the list of payment terms via this API call: https://books.zoho.com/api/v3/settings/paymentterms?organization_id=XXXX"
Function and workflow to create customer payment and send receipt
I am attempting to set up a workflow/custom function for the automatic creation of a customer payment and sending the email receipt, but am receiving the error "Improper Statement Error might be due to missing ';' at end of the line or incomplete expression" I've been over everything several times and cannot see where the error is (code is copied into the attached document). I haven't used custom functions before with Deluge, so it's very likely something very simple, or I've completely mucked
How to rename the Submit Button by using deluge script
Hi everyone, As we know, the Submit button can be renamed in the form builder setting. But I have scenario where I need the Submit Button to be renamed differently according to condition. Anyone knows how to do it? Thank You
Banking: Transfer from another account without base currency
Scenario: A banking line item shall be categorised as an "internal transfer" from another bank account. This is a USD to EUR transfer. Our base currency is CHF. What we tried: Category: "Transfer from another account" From: Our USD account To: Our EUR
Item cost price - How to accomodate changing cost prices
I am in urgent need of assistance with how to accommodate changing cost prices for items, not manually. We import items so their landed cost is always changing. This cost is NOT reflected however in the item cost price. This is going to cause us some
Marketer's Space: Targeted messaging : Leveraging Zoho Campaigns for Effective Communication
Hello Marketers, Welcome back to Marketers’ Space! Targeted messaging ensures your communication reaches the right audience - boosting engagement, conversions, and overall campaign success. In this post, we’ll be looking at targeted messaging to create
:between: conditions in search?criteria
Hello, please help solve problem I try to select deals by Creater_Time between dates i send this GET request /crm/v4/deals/search?criteria=(Created_Time:between:(2024-02-01T18:52:56,24-02-17T18:52:56)) encoded to /crm/v4/deals/search?criteria=%28Created_Time%3Abetween%3A%282024-02-01T18%3A52%3A56%2C24-02-17T18%3A52%3A56%29%29
Zoho Creator : Updating Records via Import. Can't use Autonumber or ZohoRecordID ?
Hi, I am trying to use the function to update a report with an import. I'm running in to the error : "unable to update because the form has no column with unique values" In the release notes it says Only field with unique values can be used to compare
💡 Feature Request: Custom App Bundle Plan (Pick Only the Apps You Need)
Request: Allow Users to Build a Custom App Bundle (Choose Only the Apps They Need) Hi Zoho Team, I appreciate the value that Zoho One and the Plus Bundles (CRM Plus, Finance Plus, etc.) offer. However, I’m finding it difficult to get the best fit for
Search Feature Now Broken
I have many hundreds of notes on Zoho Notebook but now when I search for a keyword, I only get 30 results maximum. This is unacceptable and yet another feature that has become broken on this quickly deteriorating software. Please fix immediately.
Restrict Zoho One Account Notifications to Admins
Hi Zoho One Team, I hope you're doing well. We recently noticed that end users are receiving administrative pop-ups in Zoho One, such as the DKIM configuration notice (screenshot attached). This type of notification is only relevant to administrators
Automated Checkout
Hi Team, I’m trying to create an automated checkout function in Zoho People. My requirement is that if an employee forgets to check out, the system should automatically check them out after 10 hours. However, I'm encountering an error while updating the
Zoho CRM Community Digest - June 2025 | Part 1
**We offer both video and written formats, take your pick and jump in.** CRM FOMO is real. You could be doing everything right and still miss the beat. That’s where we come in. Zoho CRM Community Digest! Every two weeks, we bring you the insider scoop
Introducing Video Tutorials for the Zoho FSM Mobile App
We’re excited to announce the launch of our brand-new video tutorials for the Zoho FSM Mobile App—designed painstakingly to help your field agents get up to speed in no time! Whether you're brand new to the Zoho FSM mobile app or just need a quick refresher,
Zoho People > Managed People > User Access Control
Hello All I need your recommendation on how should i go about setting the User Access Control in my Zoho People
What happened to the tabs in the ribbon on the top in my CRM?
Hi, This morning all of the tabs (modules) in the ribbon on top are no longer showing up. I had the modules in the ribbon in a specific order for easy, one-click access. Now it's only showing the active tab and the rest are hiding under the three dots
Connect to Australian bank
How do I connect to an Australian bank. No Australian bank shows up in my list. I think its because the service provider is Token and not Yodlee. How do I change this?
Searching for content within courses
Hello, I have been testing out Zoho One for my company have been exploring Learn. I've noticed that you cannot search for content within a course. You can only locate the title of the course. Example: Course: How to Make Your Bed Chapter: Pillows Lesson:
Citations Problem
I'm having an odd problem with the "Add Citations" feature of Zoho Writer. When I add a citation using the "Fetch website details online" feature it works the first time I use it but if I try it a second time by clicking that link nothing at all happens
Zoho People Leave Balance Show as Negative
Hi All I have the Portugal material Leave that policy allows up to 120 days or 150days for employee to apply within 365 days and employees is able to take minimum of 1 days or up to 120 days In my Leave Grant I have set as the setting.
Zoho People > Performance > Appraisal > Mismatch between the template-configured module and the currently enabled module.
Hello There When we enable the performance module there a prompt Mismatch between the template-configured module and the currently enabled module. How do we resolve this
Introducing WhatsApp integration in Bigin
Greetings! In today's business landscape, messaging apps play a significant role in customer operations. Customers can engage with businesses, seek support, ask questions, receive personalized recommendations, read reviews, and even make purchases—all
Zoho People Leave Application Module Error: Leave balance has exceeded as on 09-07-2025.
Dear All I need to check how do i resolve the issue of Error: Leave balance has exceeded as on 09-07-2025. All my leave have this issue
Power of Automation:: Daily Time log summary broadcast to Zoho Cliq using Schedule Custom Functions
Hello Everyone, A Custom function is a user-written set of code to achieve a specific requirement. Set the required conditions needed as when to trigger using the Workflow rules (be it Tasks / Project) and associate the custom function to it. Requirement:
When Calls Ends, Creating Note with the call description by deluge code
Hi, i need help with writing deluge code function, to scenario is like this - i want to create a workflow thats after 10 that the call ends the deluge function will create a new note in module calls that link the note in module calls to the his lead ticket
Default Memo from Custom Field (from Bill) when Paying with Check
Hi, we are using "Pay via Check" option to pay for our Bills in Zoho Books. I would like the memo on the check to pull directly from one of the custom field values within the Bill. Is there any way I can do this? The memo that I need is already on the
Next Page

Kaizen #134 Manipulating Rich Text Field (RTF) using Zoho CRM APIs

Kaizen #134 Manipulating Rich Text Field (RTF) using Zoho CRM APIs

1. What is a Rich Text Field?

2. Use case

3. Rich Text Field creation in a module using the Create Custom Field API

4. Adding values to the RTF using the Insert Records API

5. Fetch complete data of RTF using the Rich Text Field API

6. Updating Rich Text Field using the Update Records API

7. Deleting RTF using the Delete Custom Field API

8. Rich Text Field using the COQL API

9. Rich Text Field using Bulk APIs

Topic Participants

Subramanian K

Vigneshwaran K

Sticky Posts

Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI

Kaizen #152 - Client Script Support for the new Canvas Record Forms

Kaizen #197: Frequently Asked Questions on GraphQL APIs

Kaizen #198: Using Client Script for Custom Validation in Blueprint

Celebrating 200 posts of Kaizen! Share your ideas for the milestone post

Recent Topics

What is Zoho Marketing Plus?

I didn't receive my domain verification mail

Creating a new deal with specific layout and pipeline

Announcing New Features in Trident for macOS (v.1.21.0)

Modifying Product Details

Zoho Commerce B2B

Creating a custom CSV file using deluge script/

How can I get a nested value attributes inside a key par?

Invoices not arriving and mail server settings

Multi Line Text Character Limit

Emails bouncing to Hotmail / Outlook.com

Be careful if you want to purchase zoho one

Schedule Timeout 5 minutes vs. stated 15 minutes

Importing invoices in bulk using the xls file template - still posting as draft - Is there a way to skip "mark as sent" and post it directly?

How to set Sales Order Payment Terms when creating a Sales Order via the Zoho Books API

Function and workflow to create customer payment and send receipt

How to rename the Submit Button by using deluge script

Banking: Transfer from another account without base currency

Item cost price - How to accomodate changing cost prices

Marketer's Space: Targeted messaging : Leveraging Zoho Campaigns for Effective Communication

:between: conditions in search?criteria

Zoho Creator : Updating Records via Import. Can't use Autonumber or ZohoRecordID ?

💡 Feature Request: Custom App Bundle Plan (Pick Only the Apps You Need)

Search Feature Now Broken

Restrict Zoho One Account Notifications to Admins

Automated Checkout

Zoho CRM Community Digest - June 2025 | Part 1

Introducing Video Tutorials for the Zoho FSM Mobile App

Zoho People > Managed People > User Access Control

What happened to the tabs in the ribbon on the top in my CRM?

Connect to Australian bank

Searching for content within courses

Citations Problem

Zoho People Leave Balance Show as Negative

Zoho People > Performance > Appraisal > Mismatch between the template-configured module and the currently enabled module.

Introducing WhatsApp integration in Bigin

Zoho People Leave Application Module Error: Leave balance has exceeded as on 09-07-2025.

Power of Automation:: Daily Time log summary broadcast to Zoho Cliq using Schedule Custom Functions

When Calls Ends, Creating Note with the call description by deluge code

Default Memo from Custom Field (from Bill) when Paying with Check

Next Page