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 #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
Kaizen #193: Creating different fields in Zoho CRM through API
🎊 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.
Client Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands

Recent Topics
Add Comprehensive Accessibility Features to Zoho Desk Help Center for End Users
Hello Zoho Desk Team, We hope you're doing well. We’d like to submit a feature request to enhance the client-facing Help Center in Zoho Desk with comprehensive accessibility features, similar to those already available on the agent interface. 🎯 Current
Rename Record Summary PDF in SendMail task
So I've been tasked with renaming a record summary PDF to be sent as part of a sendmail task. Normally I would offer the manual solution, a user exports the PDF and uploads it to a file upload field, however this is not acceptable to the client in this
in zoho creator Sales Returns form has sub form Line Items return quantity when i upate the or enter any values in the sub form that want to reflect in the Sales Order form item deail sub form field Q
in zoho creator Sales Returns form has sub form Line Items return quantity when i upate the or enter any values in the sub form that want to reflect in the Sales Order form item deail sub form field Quantity Returned\ pls check the recording fetch_salesorder
Estimates with options and sub-totals
Hi It seems it would be great to be able to show multiple options in an estimate. For instance I have a core product to which I can add options, and maybe sub-options... It would be great to have subtotals and isolate the core from the not compulsory items. Thanks
Optional Items Estimate
How do you handle optional items within an estimate? In our case we have only options to choose with. (Like your software pricing, ...standard, professional, enterprise) How can we disable the total price? Working with Qty = 0 is unprofessional....
Important Update : Zendesk Sell announced End of Life
Hello Zendesk users, Zendesk has officially announced that Zendesk Sell will reach its End of Life (EOL) on August 31, 2027 (Learn more). In line with this deprecation, Zoho Analytics will retire its native Zendesk Sell connector effective October 1,
Zoho Sheets
Hi, I am trying to transition into Zoho sheets, I have attached the issues encountered. Server issues, file trying to upload for more than 30 mins, even once uploaded my data aren't loaded. Simple calculations are not working I have attached the sample.
Zoho CRM + Zoho FSM : alignez vos équipes commerciales et techniques
La vente est finalisée, mais le parcours client ne fait que commencer ! Dans les entreprises orientées service, conclure une vente représente seulement la première étape. Ce qui suit — installation, réparation ou maintenance régulière — influence grandement
Top Bar Shifting issue still not fixed yet
I mentioned in a previous ticket that on Android, the top bar shifts up when you view collections or when you're in the settings. That issue still hasn't been fixed yet. I don't wanna have to reinstall the app as I've noticed for some reason, reinstalling
Power of Automation:: Automate the process of updating project status based on a specific task status.
Hello Everyone, Today, I am pleased to showcase the capabilities of a custom function that is available in our Gallery. To explore the custom functions within the Gallery, please follow the steps below. Click Setup in the top right corner > Developer
ZOHO SHEETS
Where can I access desktop version of zoho sheets? It is important to do basic work If it is available, please guide me to the same
Attention API Users: Upcoming Support for Renaming System Fields
Hello all! We are excited to announce an upcoming enhancement in Zoho CRM: support for renaming system-defined fields! Current Behavior Currently, system-defined fields returned by the GET - Fields Metadata API have display_label and field_label properties
Billing Management: #3 Billing Unbilled Charges Periodically
We had a smooth sail into Prorated Billing, a practice that ensures fairness when customers join, upgrade, or downgrade a service at any point during the billing cycle. But what happens when a customer requests additional limits or features during the
No bank feeds from First National Bank South Africa since 12 September
I do not know how Zoho Books expects its customers to run a business like this. I have contacted Zoho books numerous times about this and the say it is solved - on email NO ONE ANSWERS THE SOUTH AFRICAN HELP LINE Come on Zoho Books, you cannot expect
Citation Problem
I had an previous ticket (#116148702) on this subject. The basic problem is this; the "Fetch Details" feature works fine on the first attempt but fails on every subsequent attempt, Back in July after having submitted information electronically and was
Open Sans Font in Zoho Books is not Open Sans.
Font choice in customising PDF Templates is very limited, we cannot upload custom fonts, and to make things worse, the font names are not accurate. I selected Open Sans, and thought the system was bugging, but no, Open Sans is not Open Sans. The real
Failing to generate Access and Refresh Token
Hello. I have two problems: First one when generating Access and Refresh Token I get this response: As per the guide here : https://www.zoho.com/books/api/v3/#oauth (using server based application) I'm following all the steps. I have managed to get
Zeptomail 136.143.188.150 blocked by SpamCop
Hi - it looks like this IP is being blocked, resulting in hard bounces unfortunately :( "Reason: uncategorized-bounceMessage: 5.7.1 Service unavailable; Client host [136.143.188.150] blocked using bl.spamcop.net; Blocked - see https://www.spamcop.net/bl.shtml?136.143.188.150
Apply transaction rules to multiple banks
Is there any way to make transaction rules for one bank apply to other banks? It seems cumbersome to have to re-enter the same date for every account.
How to bulk update records with Data Enrichment by Zia
Hi, I want to bulk update my records with Data Enrichment by Zia. How can I do this?
Need Guidance on SPF Flattening for Zoho Mail Configuration
Hi everyone, I'm hoping to get some advice on optimizing my SPF record for a Zoho Mail setup. I use Zoho Mail along with several other Zoho services, and as a result, my current SPF record has grown to include multiple include mechanisms. My Cloudflare
How do I split a large CSV file into smaller parts for import into Zoho?
Hi everyone, I’m trying to upload a CSV file into Zoho, but the file is very large (millions of rows), and Zoho keeps giving me errors or takes forever to process. I think the file size is too big for a single import. Manually breaking the CSV into smaller
Client Script Payload Size Bug
var createParams = { "data": [{ "Name": "PS for PR 4050082000024714556", "Price_Request": { "id": "4050082000024714556" }, "Account": { "id": "4050082000021345001" }, "Deal": { "id": "4050082000023972001" }, "Owner": { "id": "4050082000007223004" }, "Approval_Status":
Sync Issue Between Zoho Notebook Web App on Firefox (PC) and Android App
Hi Zoho Notebook Community, I'm facing a sync problem with Zoho Notebook. When I use the web version on Mozilla Firefox browser on my PC, I create and save new notes, and I've synced them successfully. However, these new notes aren't showing up in my
Messages not displayed from personal LinkedIn profile
Hello. I connected both our company profile and my personal profile to Zoho social. I do see all messages from our company page but none from my private page. not even the profile is being added on top to to switch between company or private profile,
lead convert between modules
Hello, The workflow we set up to automatically transfer leads registered via Zapier into the Patients module to the Leads module started to malfunction unexpectedly on September 25, 2025, at 11:00 AM. Under normal circumstances, all fields filled in the
Flow Task Limits - How to Monitor, Understand Consumption?
So, I got an email last night saying that I've exhausted 70% of my tasks for this month, and encouraging me to buy more tasks. I started to dig into this, and I cannot for the life of me figure out where to find any useful information for understanding,
Cross References Do Not Update Correctly
I am using cross references to reference Figures and current am just using the label and number, i.e. Figure #. As seen here: When I need to update the field, I use the update field button. But it will change the cross reference to no longer only including
Manage control over Microsoft Office 365 integrations with profile-based sync permissions
Greetings all, Previously, all users in Zoho CRM had access to enable Microsoft integrations (Calendar, Contacts, and Tasks) in their accounts, regardless of their profile type. Users with administrator profiles can now manage profile-based permissions
How to Track and Manage Schedule Changes in Zoho Projects
Keeping projects on track requires meticulous planning. However, unforeseen circumstances can cause changes to schedules, leading to delays. It becomes important to capture the reason for such changes to avoid them in the future. Zoho Projects acknowledges
Is there a notification API when a new note is addeding
Trying to push to Cliq, or email notification when there's a new note added in module. How to implement this?
Zoho Sheet - Desktop App or Offline
Since Zoho Docs is now available as a desktop app and offline, when is a realistic ETA for Sheet to have the same functionality?I am surprised this was not laucned at the same time as Docs.
Collaborate Feature doesn't work
Hello Team. It seems that the collaborate section is broken? I can post something but it all appears in "Discussions". In there is no way how I would mark something as Draft, Approval, post or any of the other filter categories? Also if I draft a post
Edit Permission during and after approval?
When a record is sent for approval Can a user request for edit permission from the approver? We don't want to give edit permissions for all the records under approval Only on a case-by-case basis How can we achieve this?
Zoho web and mobile application not workingn
Both zoho forms web and mobile application aren't working. I have checked my network connections and they are fine.
Introducing the revamped What's New page
Hello everyone! We're happy to announce that Zoho Campaigns' What's New page has undergone a complete revamp. We've bid the old page adieu after a long time and have introduced a new, sleeker-looking page. Without further ado, let's dive into the main
Prevent stripping of custom CSS when creating an email template?
Anyone have a workaround for this? Zoho really needs to hire new designers - templates are terrible. A custom template has been created, but every time we try to use it, it strips out all the CSS from the head. IE, we'll define the styles right in the <head> (simple example below) and everything gets stripped (initially, it saves fine, but when you browse away and come back to the template, all the custom css is removed). <style type="text/css"> .footerContent a{display:block !important;} </style>
Bulk Moving Images into Folders in the Library
I can't seem to select multiple images to move into a folder in order to clean up my image library and organize it. Instead, I have to move each individual image into the folder and sometimes it takes MULTIPLE tries to get it to go in there. Am I missing
Latest updates in Zoho Meeting | Breakout rooms and End to end encryption
Hello everyone, We’re excited to share a few updates for Zoho Meeting. Here's what we've been working on lately: Introducing Breakout Rooms for enhanced collaboration in your online meetings and End-to-end encryption to ensure that the data is encrypted
Systematic SPF alignment issues with Zoho subdomains
Analysis Period: August 19 - September 1, 2025 PROBLEM SUMMARY Multiple Zoho services are causing systematic SPF authentication failures in DMARC reports from major email providers (Google, Microsoft, Zoho). While emails are successfully delivered due
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 #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

Kaizen #193: Creating different fields in Zoho CRM through API

Client Script | Update - Introducing Commands in Client Script!

Recent Topics

Add Comprehensive Accessibility Features to Zoho Desk Help Center for End Users

Rename Record Summary PDF in SendMail task

in zoho creator Sales Returns form has sub form Line Items return quantity when i upate the or enter any values in the sub form that want to reflect in the Sales Order form item deail sub form field Q

Estimates with options and sub-totals

Optional Items Estimate

Important Update : Zendesk Sell announced End of Life

Zoho Sheets

Zoho CRM + Zoho FSM : alignez vos équipes commerciales et techniques

Top Bar Shifting issue still not fixed yet

Power of Automation:: Automate the process of updating project status based on a specific task status.

ZOHO SHEETS

Attention API Users: Upcoming Support for Renaming System Fields

Billing Management: #3 Billing Unbilled Charges Periodically

No bank feeds from First National Bank South Africa since 12 September

Citation Problem

Open Sans Font in Zoho Books is not Open Sans.

Failing to generate Access and Refresh Token

Zeptomail 136.143.188.150 blocked by SpamCop

Apply transaction rules to multiple banks

How to bulk update records with Data Enrichment by Zia

Need Guidance on SPF Flattening for Zoho Mail Configuration

How do I split a large CSV file into smaller parts for import into Zoho?

Client Script Payload Size Bug

Sync Issue Between Zoho Notebook Web App on Firefox (PC) and Android App

Messages not displayed from personal LinkedIn profile

lead convert between modules

Flow Task Limits - How to Monitor, Understand Consumption?

Cross References Do Not Update Correctly

Manage control over Microsoft Office 365 integrations with profile-based sync permissions

How to Track and Manage Schedule Changes in Zoho Projects

Is there a notification API when a new note is addeding

Zoho Sheet - Desktop App or Offline

Collaborate Feature doesn't work

Edit Permission during and after approval?

Zoho web and mobile application not workingn

Introducing the revamped What's New page

Prevent stripping of custom CSS when creating an email template?

Bulk Moving Images into Folders in the Library

Latest updates in Zoho Meeting | Breakout rooms and End to end encryption

Systematic SPF alignment issues with Zoho subdomains

Next Page