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
Unapplied AP Credits not showing up on AP Detail Aging
I am new to using Zoho Books. I was reconciling some accounts and found differences from the GL balance and AP Aging and it came down to unapplied vendor credits. Is there an option to include that on the report, so I can pull a matching AP Aging to the
Add Entry and Subform Record from Deluge Scripts
Hi all, I would like to know how do I add a new entry and also subform records from a deluge scripts. I can use the insert into to add a new entry to a form, but how do i insert a collection into the subform of the entry? I am using a deluge script
Finding draft ticket replies
Is there a way to see all tickets which have draft replies?
How to apply a tag to a ticket based on the to email address?
I need to assign a tag to a ticket if the ticket was sent to a specific email address. For example, we have the email accounting[at]company.com forwarding into Zoho Desk. We would like all emails that were sent to this address to be tagged with an Accounting
Engineering Change Order Process using Tickets?
Hi Zoho Community, I'm working with my company to create an Engineering Change Order/Request (ECO/ECR) process where engineers can internally create tickets for changes in a product that must be reviewed, approved and implemented by people or teams in
How can I move a ticket from Department A to Department B?
Hi there, how do I move ticket from Department A to Department B? I went in the ticket and tried to scroll down the menu under the "department" but it won't let me, I am a support admin. Did I do anything wrong? or am I doing it in the wrong place?
Validation Rules Trigger on Untouched Fields
In Zoho Desk, validation rules trigger for ALL fields during an update—even fields that weren't modified in the current edit. This behavior is fundamentally different from Zoho CRM and other Zoho products, where validation rules only apply to fields actually
How to work with getFieldNames formdata functions ,Any Examples
I don't find any example showing usage of getFieldNames. Where do i find .is there any Help documents available
Zoho Notifications - Received two notifications for one message and none for the other
We had a client reply to a ticket twice in one minute. The ticket owner received two emails for the second message but none for the first (which was crucial content and unfortunately was therefore missed). I'm assuming this created a race condition -
What is the difference between "Reply" and "Public Comment" in a ticket?
Hey, my company is thinking about switching to Zoho Desk but we do not understand the difference between the "Reply" and the "Public Comment" feature. When should we use which? And why? What is the difference between them? Thank you for your help! Kindest
Tasks View for Opportunity/Jobs does not indicate "Related To" account
How can ZoHo be setup so that when a task is created for an Opportunity, the subject automatically lists the underlying account? Right now, it's impossible to link the Account to the task when the task is created from the Job. Therefore, the open task view is inadequate. And it's a lot of maintenance to have to manually add the account to the subject...defeating the purpose of "Automated" workflow.
can i show alert when i finish running the function?
how i can show alert inside the custom function or popup notification. when i use alert inside the custom function it show this error Error at line number: 2 'ALERT' task can be used only in on load, on validate and on change actions
CRM calendar not syncing with Zoho Calendar
The sync is not happening: This is my Zoho Calendar CalDAV synced with Outlook This is my Zoho CRM Calendar (sadly empty ...) I have enabled CalDAV Access. In Zoho Calendar, I have set up APP Calendar sync like this: What else can I check? Thank
Pipeline in Custom Modules
I love the way the Sales Pipeline looks and functions with reports. I would like to add the save pipeline features and visualization to a custom module, however, I only see that these pipelines are only available for the Deals module. Is there a way to add pipelines to custom modules?
Cannot associate event with other objects when creating?
I am attempting to associate an Event with one or more other objects when creating it via the API. According to the API docs, the "Related_To" property is a jsonobject even though the description says "Provide the details about the entities the event
How to disable subform records dynamically
Hi Everyone I have a requirement to dynamically disable or hide subform fields based on certain criteria. However, the code I tried didn't work as expected. It either disabled or hid all the fields in all subform records or none at all. What I actually
Client Script Operate Timeout
Hi Zoho, I have set a client script that use for ( i =1; length < i , i++) to fetch all of the product in order I have an order have 30+ products, seems this script will be stopped when it is checking rough 10 + products because of timeout (may be). May
Why and When to Manually Regenerate Reports?
What is the protocol for needing to regenerate reports? It is very confusing when data in reports pulls correctly sometimes, but are inaccurate other times. Why is report regenerating necessary at all - can the report function not read the live data as inputted into the forms? We have built lots of reports and it is very tedious and time consuming to have to regenerate the report before each use of that data to make sure it is accurate. Is there a way to know when a report should or shouldn't
Import template from Zoho Writer
I am trying to import a mail merge template - tried to import direct from my .docx file on my hard drive and the formatting went all over the place. I then imported the .docx file in my Zoho Docs and then fixed up the formatting within Zoho Writer. Can
Button Duplication when emails forwarded or replied
When I create a new email template in campaigns and send it out it looks fine to all the users, however if that email is then on forwarded or replied to then all buttons within the email duplicate. See below The one on the left is the original one.
Enhancements to Custom Connectors in Zoho Creator
Hello everyone, At Zoho Creator, we believe in providing you with the necessary tools to achieve a well connected ecosystem of apps. Our Custom Connectors feature is a testament to this, enabling you to integrate with a wide range of external services
AutoScan Not Working Since April -Support says it with engineering
Hi there, Autoscan has not been working on my account since April. Without this feature, completing expenses reports is laborious and error-prone. I keep asking for updates seeing as this is a critical feature, but told that it's being looked into and
Zoho books bulk update for invoices
Hi Zoho team, Why only 25 invoices can be bulk update at a time. I am booking 800 to 900 invoices in a month. Please increase this limit? Please dont tell that you dont have enough request for this task. 25 limit for bulk update is too much low
Querying CloudSQL using NodeJS?
How can I query CloudSQL over nodejs? Are there any rest apis from which I perform Select Queries in the data of a Workspace? In the v1 we had C#, Python, Java for CloudSQL Now I only see Java? I am confused about the overall API of Analytics, there any
Rename Record Templates in Zoho Creator
Hi Team, I need to rename the Record Templates based on the name of the employee which i have configured in Zoho Creator Deluge Script. How to do this one? // Attachments :template:PDF_ECF:Exit_Clearance_Form input.ID as PDF
Les Zoholics 2025 sont de retour
Bonjour à tous, Préparez-vous pour deux jours exceptionnels au cœur de l’écosystème Zoho ! Nous avons le plaisir de vous convier à Zoholics France 2025, un événement dédié à l’innovation, à l’expertise et à la communauté Zoho. Au programme : • Présentations
Salutation
Hey there, I want to make an indvidual salutation. It is possible to use if statements in the email templates? For exampe: When is male then wirte "Dear Mr." else write "Dear Mrs." Thanks David
Personal Expenses
I have reviewed the board and found a few scenarios like mine however not exactly so sorry if this is a re-post. I just recently joined Zoho Books and had to go through 2000 transactions manually which took FOREVER. So the dilemma that I am facing is that I have attached my personal and business checking cards to my account because it was not until half way through 2015 that I decided to open up a business account as an independent contractor. When I first started my account I placed the opening
Not receiving instagram verfication emails
Hi- I'm not receiving Not receiving instagram verfication emails. I have seen other users having the same issue and your answer was to contact instagram. But instagram no longer has a support email.
Change work hours per day for employees
Hello, Is there a way to modify the work hours per day for employees in Zoho projects? This would be helpful for resource allocation to more accurately see when an employee who works 35 hours a week vs 40 hours has a full schedule. Thanks.
PROBLEMA AL CONECTAR EL DOMINIO
hola buenas tardes hoy estoy tratando de crear mi registro y no me deja conectar el dominio me dice que el dominio ya está vinculado a una cuenta y la verdad no tiene conectado el dominio a ninguna cuenta tengo acceso al hosting y cpanel que se compro pero al revisar los dns estan apuntando al mismo hosting del panel del proveedor del domini ... como hago para poder crear la cuenta con ese dominio, incluso cree un registro pero no me deja vincularlo el dominio es integrasoft.co agradezco me ayuden
Delay in delivery of emails
I'm experiencing random delays for emails sent from Zoho account. Headers show that the message reached mx.zohomail.com almost instantly, followed by a delay of anywhere from 3-15 minutes (and counting). Please confirm whether this is a system-wide
Zoho Mail not working. Constant OTP
Firstly, my emails have been playing up for over a year. They are struggling to send and I have to press Send a few time to make them going. They mostly hover with a loading note saying Sending. I emailed Zoho and they got it working, but now it is doing
Zoho Mail Storage Usage Discrepancy – Incorrect Storage Reporting
Dear Zoho Support Team and Community, I previously raised a concern about inaccurate storage usage reporting in Zoho Mail but did not receive a clear or satisfactory response. To investigate further, I meticulously calculated the storage used by all folders
What Is ZOHO-Workplace? Why was I charged?
Hi, Today my PayPal account was charged $12.72 for ZOHO-Workplace. The transaction ID is 15S32484H3826544W. What is this charge for? It is the first time I am seeing it.
Building a custom site
do we have an option in Zoho to build custom sites like adding custom functionalities? want to make a site like https://trackscourier.com/jnt-tracking-ph/. Is it doable? Please assist.
Missing Payload Details
Hi All, Does anyone know how to fix missing webhook payload data in the next step of the flow? Payload comes into the webhook -- All details here When i go to use the webhook data in the next step -- the majority of the payload data is missing
Numeric options in Decision
Zoho really needs to add options for numeric comparisons in the Decision action. These are the ones that should be implemented: Greater than Less than Greater than or equal to Less than or equal to Equal to (although this is actually handled already)
Supercharge your VoC analyses with data from anywhere: Modules are now sources for VoC
Dear customers, We hope you're well! Your customers talk about your brand, praise your service, criticize your offerings, or promote your business—literally from anywhere on the internet—and it has become strategically necessary to factor in all possible
Nouveautés Zoho Flow - Intégration SAP S/4HANA et SAP HANA
Bonne nouvelle! Deux applications très attendues dans la galerie d’intégrations de Zoho Flow sont désormais disponibles : ✨ SAP S/4HANA ✨ SAP HANA Que vous gériez des opérations d’entreprise ou des systèmes de données, ces intégrations vous permettent
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

Unapplied AP Credits not showing up on AP Detail Aging

Add Entry and Subform Record from Deluge Scripts

Finding draft ticket replies

How to apply a tag to a ticket based on the to email address?

Engineering Change Order Process using Tickets?

How can I move a ticket from Department A to Department B?

Validation Rules Trigger on Untouched Fields

How to work with getFieldNames formdata functions ,Any Examples

Zoho Notifications - Received two notifications for one message and none for the other

What is the difference between "Reply" and "Public Comment" in a ticket?

Tasks View for Opportunity/Jobs does not indicate "Related To" account

can i show alert when i finish running the function?

CRM calendar not syncing with Zoho Calendar

Pipeline in Custom Modules

Cannot associate event with other objects when creating?

How to disable subform records dynamically

Client Script Operate Timeout

Why and When to Manually Regenerate Reports?

Import template from Zoho Writer

Button Duplication when emails forwarded or replied

Enhancements to Custom Connectors in Zoho Creator

AutoScan Not Working Since April -Support says it with engineering

Zoho books bulk update for invoices

Querying CloudSQL using NodeJS?

Rename Record Templates in Zoho Creator

Les Zoholics 2025 sont de retour

Salutation

Personal Expenses

Not receiving instagram verfication emails

Change work hours per day for employees

PROBLEMA AL CONECTAR EL DOMINIO

Delay in delivery of emails

Zoho Mail not working. Constant OTP

Zoho Mail Storage Usage Discrepancy – Incorrect Storage Reporting

What Is ZOHO-Workplace? Why was I charged?

Building a custom site

Missing Payload Details

Numeric options in Decision

Supercharge your VoC analyses with data from anywhere: Modules are now sources for VoC

Nouveautés Zoho Flow - Intégration SAP S/4HANA et SAP HANA

Next Page