Your use case. Our milestone. The 200th post in our "Kaizen Series: Continuous Improvement for Developer Experience" is coming up. Share Now

X
Skip to product menu
close
EXPLORE ALL PRODUCTS

Sales

CRM

Comprehensive CRM platform for customer-facing teams.

CRM
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
Thrive

Complete loyalty and affiliate management platform.

Thrive
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Social

All-in-one social media management software.

Social
Survey

Design surveys to reach and interact with your audience.

Survey
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Sites

Online website builder with extensive customisation options.

Sites
Backstage

End-to-end event management software.

Backstage
PageSense

Website conversion optimization and personalisation platform.

PageSense
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
Webinar

Webinar platform for webcasting online webinars.

Webinar
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
NEW
Domains

Easy domain registration, transfer, and secured DNS management.

Domains
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
Thrive

Complete loyalty and affiliate management platform.

Thrive
Publish

Manage all your local business listings on a single platform.

Publish
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

Desk

Helpdesk software to deliver great customer support.

Desk
Assist

Remote support and unattended remote access software.

Assist
Voice

Cloud Contact Center Software for businesses.

Voice
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
FSM

End-to-end field service management platform for service businesses.

FSM
Lens

Interactive remote assistance software with augmented reality.

Lens
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

Books

Powerful accounting platform for growing businesses.

Books
Expense

Effortless expense reporting platform.

Expense
Sign

Digital signature app for businesses.

Sign
Inventory

Powerful stock management and inventory control software.

Inventory
FREE
Invoice

100% Free invoicing solution.

Invoice
Billing

End-to-end billing solution for your business.

Billing
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Commerce

eCommerce platform to manage and market your online store.

Commerce
Checkout

Collect payments online with custom branded pages.

Checkout
Practice

Practice management software for accounting firms.

Practice
Solo

The all-in-one toolkit for solopreneurs.

Solo
NEW
Payments

Unified payment solution built for all businesses.

Payments
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email, Storage, and Collaboration

Mail

Secure email service for teams of all sizes.

Mail
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
WorkDrive

Online file management for teams.

WorkDrive
Bookings

Appointment scheduling app for consultations with customers.

Bookings
Cliq

Stay in touch with teams no matter where you are.

Cliq
Notebook

Beautiful home for all your notes.

Notebook
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
Learn

Knowledge and learning management platform.

Learn
Office Integrator

Built in document editors for web apps.

Office Integrator
Writer

Word processor for focused writing and discussions.

Writer
TeamInbox

Shared inboxes for teams.

TeamInbox
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Show

Create, edit, and share slides with a sleek presentation app.

Show
Tables

Work management tool to connect people, processes, and information.

Tables
Sheet

Spreadsheet software for collaborative teams.

Sheet
Office Suite

Powerful collaborative work platform for teams.

Office Suite
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
ToDo

Collaborative task management for individuals and teams.

ToDo
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

Expense

Effortless expense reporting platform.

Expense
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
People

Organize, automate, and simplify your HR processes.

People
Sign

Digital signature app for businesses.

Sign
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Shifts

Employee scheduling and time tracking app.

Shifts
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

Creator

Build custom apps to simplify business processes.

Creator
Assist

Remote support and unattended remote access software.

Assist
Vault

Online password manager for teams.

Vault
Directory

Workforce identity and access management solution for cloud businesses.

Directory
Lens

Interactive remote assistance software with augmented reality.

Lens
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
eProtect

Comprehensive email security and archiving for every business.

eProtect
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit

BI and Analytics

Analytics

Modern self-service BI and analytics platform.

Analytics
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

Project Management

Projects

Manage, track, and collaborate on projects with teams.

Projects
Sprints

Planning and tracking tool for scrum teams.

Sprints
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Projects Plus

Unified project management platform for intelligent, data-driven work.

Projects Plus

Developer Platforms

Creator

Build custom apps to simplify business processes.

Creator
Flow

Automate business workflows by creating smart integrations.

Flow
Office Integrator

Built in document editors for web apps.

Office Integrator
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Tables

Work management tool to connect people, processes, and information.

Tables
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
Apptics

Application analytics for all apps.

Apptics
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

IoT

NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
Projects Plus

Unified project management platform for intelligent, data-driven work.

Try now
Projects Plus
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Skip to main content

Update Custom Fields

Purpose

To update custom fields in your Zoho CRM account.

Endpoints

  • PATCH /settings/fields?module={module_API_name}
  • PATCH /settings/fields/{field_ID}?module={module_API_name}

Request Details

Request URL

To update multiple fields:

{api-domain}/crm/{version}/settings/fields

To update a single field:

{api-domain}/crm/{version}/settings/fields/{field_ID}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.fields.UPDATE   (or)
ZohoCRM.settings.fields.ALL  (or)
ZohoCRM.settings.ALL

Sample request to update a single field

Copied

Parameters

  • modulestring, mandatory

    Specify the module in which you want to update custom fields. Use the GET - Modules API to retrieve modules API names and IDs. 

    Supported modules: Leads, Contacts, Accounts, Campaigns, Cases, Invoices, Deals, Price Books, Products, Purchase Orders, Quotes, Sales Orders, Solutions, Vendors, Calls, Tasks, Events, Users, DealHistory, QuotedItems, OrderedItems, PurchaseItems, InvoicedItems, Visits, Services, Appointments, and Custom.

Note

  • All the field types and cases explained in the Create Custom Field API help document are supported by the Update Custom Field API.
  • Retrieve field IDs using the GET - Fields Metadata API.
  • The field label for system-defined fields cannot be updated.
  • A maximum of five field can be updated in a single call.
  • Conversion of one field type to another is not possible.
  • External attribute cannot be updated.
  • In text area data type:
    • The length value cannot be updated.
    • The type value cannot be updated to another type, for example, from small to rich_text.
      Sample: "textarea" : { "type": "small" }
  • The API name of a field can only be changed in the UI.
  • The HIPAA attribute can be updated if the particular module has HIPAA field allowed, and privacy settings are enabled.

Sample input to update to "Text" data type

Copied

Sample response

Copied

Input JSON 

  • idstring, mandatory

    It represents the ID of the field type you want to update. Retrieve field IDs using the GET - Fields Metadata API.

Sample request to update multiple fields

Copied

Sample input to update multiple fields

Copied

Show full

Show less

Input JSON Keys

 

Updating the picklist ("datatype" : "picklist") field

The following keys are mandatory to update a picklist field's option.

  • pick_list_valuesJSON array, mandatory

    It represents the values or options of the picklist field.

    • display_valuestring, mandatory

      The unique display value for the picklist, which will be displayed in the CRM UI.

Note

  • The display_value field is mandatory when updating an option in a picklist field.
  • Use the actual_value or unique ID of a picklist option to update its display value.
  • To remove an option from a picklist, use the Update Custom Layout API. Refer to the Sample input to mark picklist options as unused section.

Sample request to update the "picklist" datatype

Copied

Sample input to add a new option to the picklist field

Copied

Sample input to update existing picklist data

Copied

Show full

Show less

Updating rollup summary ("datatype" : "rollup_summary") field

Note

  • Inside rollup_summary.expression only the criteria field can be modified.

Sample request to update the "rollup_summary" datatype

Copied

Sample input

Copied

Show full

Show less

Updating dynamic formula ("datatype" : "formula") field

Sample request to update the "formula" datatype

Copied

Sample Input

Copied

Show full

Show less

Input JOSN

 

Converting Picklist to Global Picklist

  • fieldsJSON array, mandatory

    Contains details of the picklist field and the global picklist field.

    • idstring, mandatory

      Represents the unique ID of the picklist field you want to convert into a global picklist field.

    • pick_list_valuesJSON array, optional

      Contains the mapping details between the picklist field values and the global picklist field values.

      • idstring, mandatory

        Represents the ID of a value in the picklist field. Use the GET - Fields Metadata API to retieve all picklist fields ("data_type": "picklist") in a module.

      • _global_picklist_valueJSON object, optional

        Represents the ID of the value in the global picklist field. Use the GET - Get Global Picklists API to retieve all global picklist fields along with their values.

    • global_picklistJSON object, mandatory

      Use the GET - Get Global Picklists API to retrieve all global picklist fields available in your organization.

Note

  • You can map the values from the picklist field to the values in the global picklist field. By default, if you do not map the values, all values in the picklist field will be replaced with the global picklist field's values.
  • Any records or configurations with existing picklist values will also be replaced by the global picklist field's values.

Sample request to convert a picklist field to a global picklist field

Copied

Sample Input

Copied

Input JOSN

 

Converting a Global Picklist field to a Picklist field

  • idstring, mandatory

    Represents the unique ID of the global picklist field. Use the GET - Global Picklists API to retrieve global picklist field IDs.

  • global_picklistJSON object, mandatory

    Represents the conversion of a global picklist field into a normal picklist field. 

Sample request to convert a global picklist field to a picklist field

Copied

Sample Input

Copied

Sample response

Copied

Input JSON

 

Enable or disable history tracking for picklist fields
  • history_tracking_enabledBoolean, mandatory

    You can enable or disable history tracking for an existing picklist in a module. Use this key to enable or disable history tracking for a picklist field.

  • history_trackingJSON object, optional

    Contains the configuration details for tracking the history of the picklist field.

    • related_list_namestring, optional

      Specify the name for the related list that displays the picklist field's history in the record detail view as a related list. If not specified, the system auto-generates one based on the field label. The value for related_list_name can have a maximum of 25 characters and cannot include special characters.

    • duration_configurationstring, optional

      Specify the unit of time (e.g., days or time) for tracking history.

      Possible values:

      • days (default) - History is tracked by days.
      • time - History is tracked by time.
        • Note:  Before specifying the time value, enable the duration customization feature in your organization by contacting support@zohocrm.com.
    • followed_fieldsJSON array, optional

      Specify additional fields to track along with the main picklist field for comprehensive change tracking of related fields. Each object in the array must include either the API name or the unique ID of a followed field. Refer to the GET - Fields Metadata API to retrieve field API names and IDs for a module.  

      For instance, if a sales team tracks the Property Status picklist to monitor how long a property stays in each stage, they can add User Assigned to followed_fields to track which user handled the property at each stage.

Note

  • In the followed_fields,
    • You can select up to 10 fields in total, with a maximum of 5 user fields as followed fields in a module, except for the Deals module.
    • Deals module,
      • By default, the Deals module tracks the stage history of the Stage picklist field.
      • You can add more followed fields as columns to the existing stage history.
      • You can also change the related list name and add up to six additional followed fields. You can select upto six fields in total, with a maximum of five user fields.
    • Encrypted fields cannot be selected as followed fields.

Sample request to disable history tracking for a picklist field

Copied

Sample input to disable history tracking for a picklist field

Copied

Sample input to update the existing values in a picklist with enabled history tracking

Copied

Possible Errors

  • INVALID_DATAHTTP 400
    • The ID given seems to be invalid 
      Resolution: Specify a valid field ID.
    • Special characters have been found in the field label 
      Resolution: The field label does not support special characters.
    • Invalid formula expression 
      Resolution: Specify a valid formula expression.
  • NOT_ALLOWEDHTTP 400
    • Lookup module cannot be updated 
      Resolution: Once the lookup module is associated with the field, it cannot be updated.
    • Formula field does not support updating the return type 
      Resolution: Updating the return type in the formula field is not supported.
    • Private is not allowed 
      Resolution: Enable the privacy setting and update the private value.
    • Unique case is not allowed
      Resolution: The field you are trying to update does not support the unique key.
  • RESERVED_KEYWORD_NOT_ALLOWEDHTTP 400

    System-defined keywords not allowed in the API name
    Resolution: Specify a non-system-defined keyword for the API name.

  • DUPLICATE_DATAHTTP 400
    • Duplicate field label
      Resolution: The field label seems to be a duplicate of another field's label. Specify a unique field label.
    • Duplicate display_value has been found among the picklist options
      Resolution: One or more picklist option values have been found to be the same. Please specify a unique display value.
    • Duplicate API name has been found for a field creation
      Resolution: Specify a unique API name for a field.
    • Duplicate data has been found
      Resolution: Specify a unique value to update the field.
    • Invalid data type has been given for the "reference_value" key
      Resolution: The data type for the "reference_value" key is "string".
  • MANDATORY_NOT_FOUNDHTTP 400

    Required fields not found
    Resolution: Specify the require fields to update. Refer to the Create Custom Field API to know the mandatory fields.

  • REQUIRED_PARAM_MISSINGHTTP 400

    Required paramter is missing
    Resolution: Please specify the modules parameter and its corresponding value.

  • LIMIT_EXCEEDEDHTTP 400

    Too many options have been added to the Stage picklist field in the Deals module
    Resolution: You can add up to 220 options to the Stage picklist field in the Deals module.

  • DEPENDENT_MISMATCHHTTP 400
    • The given length value seems to be invalid.
      Resolution: The value given in the length attribute seems to be
    • The dependent fields seems to be invalid or missing
      Resolution: Specify the valid dependent keys along with their corresponding valid values.

    Refer to the Create Custom Field API to know the dependent fields.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL.
    Specify a valid request method. Refer to the endpoints section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: The client does not have a valid scope to update custom fields. Create a new token with the required scope. Refer to the Scope section to get an exact scope.

  • 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.

Sample response

Copied