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 #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 #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.
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 #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.

Recent Topics
553 Relaying disallowed - Invalid Domain
I have this error "553 Relaying disallowed. Invalid Domain" when sending an email to any email address. But I still receiving email from other emails. I checked MX, DKIM, SPF and it's ok. Could you check and help? Thanks
Turn off Organization Contact List
We need to be able to turn off the Organization Contact list for some of our staff. Once the Organization Contact list is turned off for a user, we would then like to be able to create a list of contacts on per user basis that would not be editable by
Unable to send massage Reason 553/ Relaying Disallowed. Invalid Domain
Cant sed massages from my email. All massages from my domain received the same issue Unable to send massage Reason 553/ Relaying Disallowed. Invalid Domain
Kaizen #194 : Trigger Client Script via Custom buttons
Hello everyone! Welcome back to another interesting and useful Kaizen post. We know that Client Scripts can be triggered with Canvas buttons and we discussed this with a use case in Kaizen#180. Today, let us discuss how to trigger Client Script when a
Make record entry more organized with the Sections component in Wizards
Hello everyone! Wizards in Zoho CRM have always helped you break long record-detail pages or large sets of fields into multiple screens, making data entry smoother and more user-friendly. Now, we’re taking a major step forward with a new Sections component—giving
GSTIN Public Search API
Does zohobooks have an api using which i can search GST numbers and get their details?
External @zoho.com mail stopped working today, yesterday no issues
Hello, Over a sudden mail stopped being delivered to inbox. Domain is standard zoho.com worked no problem yesterday, today nothing in inbox. Sent several test emails from corporate account & from gmail.com, logs show acceptance by zoho mail server, but
Suggestion: Smart Purchasing Module for Zoho Inventory and Zoho Books
Suggestion: Smart Purchasing Module for Zoho Inventory and Zoho Books As an active user of Zoho Inventory and Zoho Books, I’ve noticed that the suite already provides valuable tools for managing inventory, analyzing trends, and processing purchase orders.
Adding bank details to the contact through API
How to add bank-related information to the contact while creating it using API? The account number needs to be encrypted before sending it through API but not sure how to encrypt and get those values. Please guide me in this.
average cost display
Hello there, I'm using the average cost valuation method, and the cost price shown in the Items menu should reflect the latest WAC (Weighted Average Cost). However, it doesn't update automatically. Is there a way to display the current average cost without
Apple Mail issues
Dear Sir or Madam, I am trying to configure my Zoho mail account to Apple Mail. It is not working. It seems to need more information (perhaps a path prefix?) than is shown in your tutorial (<www.zoho.com/mail/help/apple-mac-imap.html>). After plugging
Assistance Required for Migrating Data from Odoo Inventory to Zoho Inventory
Hi Team, I previously used Odoo Inventory to manage my stock and transactions, and I’ve now moved to Zoho Inventory. I’d like to migrate my data from Odoo—including product details, stock, purchase, and vendor information- into Zoho Inventory for continuity
I need my entire Zoho Account (mail/organization) deleted!
Hey! I used zoho for my email aaron@aaronglass.me with domain forwarding/mx all that. I got rid of the mx info on my godaddy account and still Google won't let me sign up with my aaron@aaronglass.me email. (I'm moving to Google for business) SO! I was
Error: "Invalid Element warehouse_id" when sending order to Zoho
i'm getting the error "Invalid Element warehouse_id" when trying to send an order to Zoho via API. Has anyone faced this issue before? How can I fix it?
No way to sell individual and case units smoothly in Zoho
Currently, Zoho Inventory handles inventory primarily at the case level, which can be challenging for businesses that frequently need to break down cases into individual units for retail sales or smaller shipments. Although Zoho Inventory currently supports
How to handle multiple languages (Resume parser, Job opening, job board, career site) ?
We are looking to bring Zoho Recruit to a market that needs to support 2 languages. The first thing we need to make sure is that the Candidate be flag with the language they speak. This is easy enough make a custom field that as the desire languages.
Shipping Labels
Hi, Can we generate Packing Labels for manual shipping same as the format as Airway Bill in zoho books or inventory?
Unit Measurement Sign,
Dear Zoho Support Team, I hope you are doing well. We recently purchased Zoho Inventory based on recommendations of your team that “it would be a great fit for our Shopify operations”. However, we are currently facing several urgent issues that require
Leadchain into a custom module
Hello ZOHO Community ! is it possible to put the leads collected by leadchain into a custom module instaed of leads module ? Best wishes Niels
Urgent: How to Bulk Upload Images in Zoho Inventory? Any Workarounds?
We are currently onboarding 5,000+ items from Shopify into Zoho Inventory, but we’re struggling with the lack of a bulk image upload feature. Right now, we have to manually upload and assign images one by one, which is extremely time-consuming and inefficient.
Can I automatically update COGS and Inventory account when creating an item?
I have been trying to get Zoho to update the other two fields when I update one (Sales Account, COGS account, and Inventory Account). I know this seems like not a huge time saver, but I am all about efficiency and being an independent taproom, I create
I'm looking for a Microsoft List alternative in Zoho One to manage large lists of repetitive tasks
I've used Microsoft Lists to manage lots of tasks that need to be completed several times for different users. We started with a large spreadsheet and then discovered lists, which worked pretty well. I was wondering if there is a similar products in Zoho,
Zoholics Europe and UK Awards 2025: Honouring our loyal customers!
We're excited to announce that at this year's Zoholics events across Europe, we're holding customer awards for the first time ever! This is your chance to shout about the amazing things you've created, connected, or achieved with Bigin! And if you win,
Fillable template with dynamic tables?
Is there a way to build a fillable template so that users can add rows to a table? To describe what I'm trying to accomplish the table has 3 sections; a header row, some number of rows with custom information, and a summary row with totals. I can't figure
How to store API keys in zoho?
Hi everyone, I'm currently building an integration using Zoho Flow and I need to securely store several API keys that will be used to make external service calls from my flows. I would not like to hardcode the values in the code of custom function. What's
Zoho RPA is now available in your Zoho One bundle!
Hello All! Of late, it's been quite a stint of new app integrations in Zoho One. This announcement pertains to the addition of another Zoho application, the most sought-after Zoho RPA - Robotic Process Automation, to the bundle. What is Zoho RPA? Zoho
is there an easy way to embed a zoho analytics report into a widget (or inside the "account" page) of Zoho CRM
Hi, I have built a report that is specific to an account in Zoho CRM but I would like this to be built into the Zoho CRM front-end. I have looked at the widget concept but it seems quite complicated (see attached screenshot but I need to filter this view
Bigin iOS app update - Introducing Card Scanner and initiating WhatsApp conversations using pre-approved templates.
Hello everyone! In the latest iOS (v1.11.3) version of the Bigin app, we have introduced the following features: Card Scanner Initiating WhatsApp conversations. Card Scanner: Our new Card Scanner feature extracts contact information from business cards.
Introducing card scanner in Bigin Android app
Hello everyone! We are excited to introduce the card scanner feature on the latest Android version(1.7.26) of the Bigin app as well. Card scanner extracts contact information from business cards and allows you to save them as contacts in Bigin. You can
Full RTL and Hebrew Translation Support for Zoho Creator User Portal (Including All System Pages, Templates, and MFA Screens)
Dear Zoho Creator Team, We kindly request comprehensive support for right-to-left (RTL) languages, particularly Hebrew, across the entire Zoho Creator user portal. This includes system-generated pages, templates, and multi-factor authentication (MFA)
ZUG real estate virtual meetup 2025: Sign documents, collect payments, and automate workflows with Zoho Sign
Hi there! Are you in real estate and looking for a secure, compliant way to manage all your paperwork? In such a fast-paced industry, timing, compliance, and client trust are everything. Handling paperwork has always been a challenge, whether you're finalizing
OCR (Optical Character Recognition), automatisation des PDF et autres améliorations de Zoho RPA
Zoho RPA est une plateforme d'automatisation des processus robotiques conçue pour accélérer et simplifier vos workflows. Elle permet de connecter facilement vos applications cloud à vos systèmes existants, même ceux qui ne disposent pas d’API, afin d’automatiser
📞 Call + 💬 WhatsApp + 📲 SMS in Zoho CRM – All in One Place!
We’re excited to introduce HelloSend, a powerful communication extension for Zoho CRM that brings SMS, WhatsApp, and Voice Calling directly into your CRM workspace. Whether you're in sales, support, or service delivery, HelloSend helps you connect with
Automation#24: Auto-Update custom field from Accounts to Tickets
Hello Everyone! Welcome back to the Community Learning Series! This episode dives into how Zylker Techfix streamlines account-related ticket references. Previously, employees had to manually check account details to retrieve specific customer information,
Product Updates in Zoho Workplace applications | May 2025
Hello Workplace Community, Let’s take a look at the new features and enhancements that went live across all Workplace applications this May. Zoho Mail Increased Preset Limit for Reminder and Snooze Options Preset limits for the Reminder and Snooze options
Outlook 365 ('classic') won't connect to Zoho email
New computer, fresh install of Office desktop. On the old computer Outlook was working fine with Zoho, retrieving/sending mail, etc. On the new one I can't connect the accounts in Outlook--Outlook just keeps popping up the box asking for a password. All
login email
Never logged into email says last log in never loged into
Installment plans
Hi I am looking for a way to allow my customer to make equal monthly payments. For instance if I create an invoice for customer Y for $1000 I want to allow them to make equal monthly payments for the next 6 months. I need those payments to be auto charged
Search Mail with URL parameters
Is it possible to search Zoho Mail by passing URL params like we can in Gmail? eg. mail.google.com/mail/u/0/#search/from:(jane@doe.com)
Need Help Fetching Latest Conversion Rate by Date
Hi Team, I’m currently working on building a Balance Sheet in Zoho Analytics across different entities, with a common base currency of USD. I receive USD conversion values on a daily basis, and my requirement is to always capture the most recent available
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 #152 - Client Script Support for the new Canvas Record Forms

Kaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script

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

Kaizen #197: Frequently Asked Questions on GraphQL APIs

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

Recent Topics

553 Relaying disallowed - Invalid Domain

Turn off Organization Contact List

Unable to send massage Reason 553/ Relaying Disallowed. Invalid Domain

Kaizen #194 : Trigger Client Script via Custom buttons

Make record entry more organized with the Sections component in Wizards

GSTIN Public Search API

External @zoho.com mail stopped working today, yesterday no issues

Suggestion: Smart Purchasing Module for Zoho Inventory and Zoho Books

Adding bank details to the contact through API

average cost display

Apple Mail issues

Assistance Required for Migrating Data from Odoo Inventory to Zoho Inventory

I need my entire Zoho Account (mail/organization) deleted!

Error: "Invalid Element warehouse_id" when sending order to Zoho

No way to sell individual and case units smoothly in Zoho

How to handle multiple languages (Resume parser, Job opening, job board, career site) ?

Shipping Labels

Unit Measurement Sign,

Leadchain into a custom module

Urgent: How to Bulk Upload Images in Zoho Inventory? Any Workarounds?

Can I automatically update COGS and Inventory account when creating an item?

I'm looking for a Microsoft List alternative in Zoho One to manage large lists of repetitive tasks

Zoholics Europe and UK Awards 2025: Honouring our loyal customers!

Fillable template with dynamic tables?

How to store API keys in zoho?

Zoho RPA is now available in your Zoho One bundle!

is there an easy way to embed a zoho analytics report into a widget (or inside the "account" page) of Zoho CRM

Bigin iOS app update - Introducing Card Scanner and initiating WhatsApp conversations using pre-approved templates.

Introducing card scanner in Bigin Android app

Full RTL and Hebrew Translation Support for Zoho Creator User Portal (Including All System Pages, Templates, and MFA Screens)

ZUG real estate virtual meetup 2025: Sign documents, collect payments, and automate workflows with Zoho Sign

OCR (Optical Character Recognition), automatisation des PDF et autres améliorations de Zoho RPA

📞 Call + 💬 WhatsApp + 📲 SMS in Zoho CRM – All in One Place!

Automation#24: Auto-Update custom field from Accounts to Tickets

Product Updates in Zoho Workplace applications | May 2025

Outlook 365 ('classic') won't connect to Zoho email

login email

Installment plans

Search Mail with URL parameters

Need Help Fetching Latest Conversion Rate by Date

Next Page