Get Rich Text Fields

Rich Text Fields allow users to input formatted text up to 50,000 characters, including HTML elements. It is ideal for entries requiring styling and organization, such as product descriptions or client communications.

Purpose

To retrieve the rich text fields of a specific record along with their contents.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/{module_api_name}/{record_id}/actions/fetch_full_data

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope = ZohoCRM.modules.ALL 
(or) 
scope = ZohoCRM.modules.{module_name}.READ
 

Parameter

  • fieldsstring, optional

    Specify the API names of the rich text fields whose values you want to retrieve. If you skip this parameter, all rich text fields of the record will be retrieved.

Notes

  • This API exclusively fetches rich text fields and their data. Retrieval of any other field types is not supported.
  • You can retrieve only the data from the rich text multi-line field. Retrieving multi-line fields with other types, such as small and large, is not supported.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v6/Leads/111112000000070427/actions/fetch_full_data"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON Keys

  • idstring

    It represents the ID of the record.

  • {rich_text_field_api_name}string

    Contains the value for the specific rich text field. Please note that this key will differ depending on the API names of the rich text fields in your module.

Sample Response

Copied{
    "data": [
        {
            "Multi_Line_RTF1": "<span style=\"background-color:rgb(255, 255, 0)\"><b><i>Zoho CRM</i></b></span> can be easily customized to meet the specific needs of any business type and size. 
Modern CRM systems such as Zoho CRM are used by <b>start-ups, large enterprises, and verticals like real-estate, healthcare, insurance, legal, media, restaurants, travel, banking, tax, freelancers, and non-profits to increase their sales, marketing, and customer support efforts</b>.",

            "Multi_Line_RTF2": "<span style=\"background-color:rgb(255, 255, 0)\"><b><i>Zoho CRM</i></b></span> can be easily customized to meet the specific needs of any business type and size. 
Modern CRM systems such as Zoho CRM are used by <b>start-ups, large enterprises, and verticals like real-estate, healthcare, insurance, legal, media, restaurants, travel, banking, tax, freelancers, and non-profits to increase their sales, marketing, and customer support efforts</b>.",
            
            "id": "111112000000070427"
        }
    ]
}

Possible Errors

  • INVALID_DATAHTTP 400

    The ID of the record given seems to be invalid
    Resolution: Specify a valid record ID.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: The client does not have a valid scope to fetch the rich text field values. Generate a new token with valid scope. Refer to scope section above.

  • AUTHENTICATION_FAILUREHTTP 401

    Authentication failed
    Resolution: Pass the access token in the request header of the API call.

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to the request URL section above.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in the server. Contact support team.