Actions - Field Updates

Purpose

Retrieve all available field updates configured in your Zoho CRM account. Refer to Setting Field Updates for more details.

Endpoints

GET /settings/automation/field_updates
GET /settings/automation/field_updates/{field_update_ID}

Request Details

Request URL

To retrieve all field updates:
{api-domain}/crm/{version}/settings/automation/field_updates
To retrieve a single field update:
{api-domain}/crm/{version}/settings/automation/field_updates/{field_update_ID}

Header

Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Appointments, and Custom.

Scope

ZohoCRM.settings.automation_actions.READ

Parameters

Note

The following parameters are applicable only for the GET - /settings/automation/field_updates endpoint.

pageinteger, optional
To get the list of field updates from the respective pages. The default value is 1. Note that you cannot use this param with the "page_token" param.
Possible values: Positive integer values only.
per_pageinteger, optional
Specify how many field updates to return per page. The default and the maximum possible value is 200.
Possible values: Positive integer values only.
sort_bystring, optional
To sort the list of field updates. By default, the response is sorted by Created_Time.
Possible values: Modified_Time
sort_orderstring, optional
To sort the available list of field updates in either ascending or descending order, based on the value of "sort_by" parameter.

Possible values:
- desc : Displays field updates in descending order. This is the default value.
- asc : Displays field updates in ascending order.
include_inner_detailsinteger, optional
To retrieve additional details about the field associated with each field update.
Possible values:
- field_label : The label of the field as displayed in the Zoho CRM UI.
- enable_colour_code : To fetch the enable_colour_code in the response, which indicates whether the picklist field has color coding enabled or not.
- pick_list_values.colour_code : To fetch the HEX color code for each picklist value in the response, if defined.
- data_type : To include the filed data type in the response.
- display_value : The UI-friendly display value of the field update’s value. This is especially helpful for picklists or lookups.
feature_typestring, optional
To filter field updates by their automation feature type.
Possible values: workflow, assignment_rules
filtersstring, optional
To filter the list of field update actions by name.
Structure for the filters parameter:
{
"field": {
"api_name": "{{value}}"
},
"comparator": "contains",
"value": "{{value}}"
}

Example: {"field":{"api_name":"name"},"comparator":"contains","value":"ZOHOLICS"}
This retrieves all field updates where the name contains "ZOHOLICS".
The value for the "filters" param structured below.
- fieldsJSON object, optional
  Represents the attribute to filter with.
  Supported attributes: name
- comparatorstring, mandatory
  Represents the comparator used for filtering.
  supported value: contains
- valuestring, mandatory
  The name of the field update action to filter by.
Note
- You must encode the value of the filters parameter before sending the request.
- You can have only one criterion for this parameter.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/automation/field_updates"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON

field_updatesJSON array
Lists the field update actions configured in your Zoho CRM organization.
- created_timestring
  Represents when the field update was created.
- update_typestring
  Specifies whether the field update’s value replaces existing values or is added to the existing list. This is relevant for multi-select picklist fields.
  Possible values:
  - overwrite : Replaces existing values with the new ones.
  - append : Adds new values to the existing ones.
- lock_statusJSON object
  Contains the lock information for the field update action.
  - lockedBoolean
    Represents the status of the field update.
    Possible values:
    - true : The field update is locked. You cannot edit or delete the field update.
    - false : The field update is not locked. You can edit or delete the field update.
- apply_assignment_thresholdBoolean
  Represents if assignment rule threshold checks are applied.
  Possible values:
  - true : Assignment threshold rules are applied
  - false : Assignment threshold rules are not applied
- moduleJSON object
  Contains the details of the module where the field update applies, such as Leads, Contacts, or custom modules.
- editableBoolean
  Represents if the field update can be edited or not.
  Possible values:
  - true : The field update can be edited.
  - false : The field update cannot be edited.
- deletableBoolean
  Represents if the field update can be deleted or not.
  Possible values:
  - true : The field update can be deleted.
  - false : The field update cannot be deleted.
- sourcestring
  Represents the source of the field update.
- typestring
  Represents the type of the field update. It defines how the new value is applied to the field.
  Possible value :
  - static : A fixed value is applied
- created_byJSON object
  Contains the details of the user who created the field update action.
- notifyBoolean
  Represents if an email notification is sent to the record owner when the field update is executed. Please note that this key applies only to Owner fields.
  Possible values:
  - true : Let the system notify when field update occurs.
  - false : Let the system not to notify when field update occurs.
- feature_typestring
  Represents the automation feature in which the field update has been used.
  Possible values: workflow and assignment_rules.
- modified_timestring
  Represents when the field update was last modified.
- fieldJSON object
  Represents the field being updated with its api_name and ID.
- dependent_fieldsJSON object
  Specifies the dependent fields that are affected when the target field is updated. This is primarily used in picklist dependencies, where the value of one field controls the valid options in another field.
  Example : If you update the Country field to India, the dependent field State will automatically be restricted to Indian states only.
- associatedBoolean
  Represents if the field update is currently linked to any automation feature in Zoho CRM like workflow, blueprints, assignment rules, connected workflow, and so on.
  Possible values:
  - true : The field update is associated with one or more CRM automation features.
  - false : The field update is not linked to any automation and can be freely modified or deleted.
- nameBoolean
  Represents the name of the field update option.
- modified_byJSON object
  Represents the name and ID of the user who last modified the field update.
- idstring
  Represents the unique ID of the field update.
- valuestring
  Represents the value to set in the specified field. It returns a string for single-value fields and an array for multi-select fields.

Possible Errors

NO_CONTENTHTTP 204
No field updates available
Resolution: Specify a valid field update ID.
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.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: The client does not have a valid scope to retrieve field updates. Create a new token with valid scope. Refer to the Scope section for details.
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 Request URL section for details.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server. Contact support team.

Sample Response

Copied{
    "field_updates": [
        {
            "created_time": "2025-06-23T04:48:52-07:00",
            "update_type": null,
            "lock_status": {
                "locked": false
            },
            "apply_assignment_threshold": false,
            "editable": true,
            "module": {
                "api_name": "Leads",
                "id": "5725767000000002175"
            },
            "related_module": null,
            "deletable": true,
            "source": "crm",
            "type": "static",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "notify": false,
            "feature_type": "workflow",
            "modified_time": "2025-07-08T03:43:11-07:00",
            "field": {
                "api_name": "Company",
                "id": "5725767000000002591"
            },
            "associated": false,
            "related_records": null,
            "name": "ZOHOLICS",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "id": "5725767000006953001",
            "value": "ZoHo"
        },
        {
            "created_time": "2025-06-26T11:40:37-07:00",
            "update_type": "overwrite",
            "lock_status": {
                "locked": false
            },
            "apply_assignment_threshold": false,
            "editable": true,
            "module": {
                "api_name": "Leads",
                "id": "5725767000000002175"
            },
            "related_module": null,
            "deletable": true,
            "source": "crm",
            "type": "static",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "notify": false,
            "feature_type": "workflow",
            "modified_time": "2025-06-26T11:59:35-07:00",
            "field": {
                "api_name": "Campaign",
                "id": "5725767000007001002"
            },
            "associated": false,
            "related_records": null,
            "name": "Languages Known",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "id": "5725767000006998001",
            "value": [
                "English",
                "Spanish",
                "Hindi"
            ]
        },
        {
            "created_time": "2025-06-26T10:54:39-07:00",
            "update_type": null,
            "lock_status": {
                "locked": false
            },
            "apply_assignment_threshold": false,
            "editable": true,
            "module": {
                "api_name": "Leads",
                "id": "5725767000000002175"
            },
            "related_module": null,
            "deletable": true,
            "source": "crm",
            "type": "static",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "notify": false,
            "feature_type": "workflow",
            "modified_time": "2025-06-26T11:21:07-07:00",
            "field": {
                "api_name": "Company",
                "id": "5725767000000002591"
            },
            "associated": false,
            "related_records": null,
            "name": "info tech",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "id": "5725767000006994002",
            "value": "info"
        },
        {
            "created_time": "2025-06-23T22:44:09-07:00",
            "update_type": null,
            "lock_status": {
                "locked": false
            },
            "apply_assignment_threshold": false,
            "editable": true,
            "module": {
                "api_name": "Leads",
                "id": "5725767000000002175"
            },
            "related_module": null,
            "deletable": true,
            "source": "crm",
            "type": "static",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "notify": false,
            "feature_type": "workflow",
            "modified_time": "2025-06-23T22:44:09-07:00",
            "field": {
                "api_name": "Company",
                "id": "5725767000000002591"
            },
            "associated": false,
            "related_records": null,
            "name": "ZOHOLICS",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "id": "5725767000006960001",
            "value": "ZoHo"
        },
        .
        .
        .
    ],
    "info": {
        "per_page": 200,
        "count": 13,
        "page": 1,
        "more_records": false
    }
}