Zoho CRM: README

To retrieve all field updates.

Tool ID: zoho_crm_field_updates_get_field_updates

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_field_updates_get_field_updates',
  {
    "sort_order": "asc",
    "sort_by": "modified_time",
    "include_inner_details": "field_label"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute zoho_crm_field_updates_get_field_updates --input '{
  "sort_order": "asc",
  "sort_by": "modified_time",
  "include_inner_details": "field_label"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "field_updates": [
      {
        "module": {
          "singular_label": "example",
          "moduleName": "Example",
          "id": "id_123"
        },
        "type": "static",
        "field": {
          "ui_type": 123,
          "id": "id_123",
          "api_name": "Example"
        },
        "name": "Example",
        "value": {}
      }
    ],
    "info": {
      "per_page": 123,
      "count": 123,
      "page": 123
    }
  }
}

Use deepline tools get zoho_crm_field_updates_get_field_updates --json for the latest machine-readable contract.

Input reference

Retrieve all available field updates

Name	Type	Required	Default	Details
`payload.sort_order`	`"asc"`	No	—	To sort the available list of field updates in either ascending or descending order, based on the value of “sort_by” parameter Allowed: `asc`.
`payload.sort_by`	`"modified_time"`	No	—	To sort the list of field updates. By default, the response is sorted by Created_Time. Allowed: `modified_time`.
`payload.include_inner_details`	`"field_label" \| "enable_colour_code" \| "pick_list_values.colour_code" \| "data_type" \| "display_value"`	No	—	To retrieve additional details about the field associated with each field update. Allowed: `field_label`, `enable_colour_code`, `pick_list_values.colour_code`, `data_type`, `display_value`.
`payload.page`	`1`	No	—	To get the list of field updates from the respective pages. The default value is 1 Allowed: `1`. Format: `int32`.
`payload.per_page`	`200`	No	—	Specify how many field updates to return per page. The default and the maximum possible value is 200 Allowed: `200`. Format: `int32`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Represents that all field updates have been retrieved successfully
`result.data.field_updates`	`array`	No	—	Field: field_updates Maximum items: 5.
`result.data.field_updates[].created_time`	`string`	No	—	Field: created_time Maximum length: 255.
`result.data.field_updates[].update_type`	`"overwrite" \| "append"`	No	—	Specify how to update the field. This key is supported only for the multi-select fields. Allowed: `overwrite`, `append`. Maximum length: 255.
`result.data.field_updates[].lock_status`	`object`	No	—	Nested schema for lock_status
`result.data.field_updates[].lock_status.locked`	`boolean`	No	—	Field: locked
`result.data.field_updates[].apply_assignment_threshold`	`boolean`	No	—	Indicates whether assignment-threshold rules should be applied when updating the field.
`result.data.field_updates[].editable`	`boolean`	No	—	Field: editable
`result.data.field_updates[].module`	`object`	Yes	—	Specify the module details where the field update should be applied.
`result.data.field_updates[].module.singular_label`	`string`	No	—	Field: singular_label Maximum length: 255.
`result.data.field_updates[].module.moduleName`	`string`	No	—	Field: moduleName Maximum length: 255.
`result.data.field_updates[].module.id`	`string`	No	—	Unique Id of the module Maximum length: 255.
`result.data.field_updates[].module.plural_label`	`string`	No	—	Field: plural_label Maximum length: 255.
`result.data.field_updates[].module.api_name`	`string`	No	—	Name of the module Maximum length: 255.
`result.data.field_updates[].related_module`	`null`	No	—	Field: related_module
`result.data.field_updates[].deletable`	`boolean`	No	—	Field: deletable
`result.data.field_updates[].source`	`string`	No	—	Field: source Maximum length: 255.
`result.data.field_updates[].type`	`"static"`	Yes	—	Specify the type of field update. (Required) Allowed: `static`. Maximum length: 255.
`result.data.field_updates[].created_by`	`object`	No	—	Nested schema for created_by
`result.data.field_updates[].created_by.name`	`string`	No	—	Field: name Maximum length: 255.
`result.data.field_updates[].created_by.id`	`string`	No	—	Field: id Maximum length: 255.
`result.data.field_updates[].notify`	`boolean`	No	—	Specify whether or not to send email notifications to the new owner.
`result.data.field_updates[].feature_type`	`"workflow"`	No	—	Specify the automation feature in which you want to use the field update. Allowed: `workflow`. Maximum length: 255.
`result.data.field_updates[].modified_time`	`string`	No	—	Field: modified_time Maximum length: 255.
`result.data.field_updates[].field`	`object`	Yes	—	Specify the API name and the unique ID of the field to be updated.
`result.data.field_updates[].field.ui_type`	`integer`	No	—	Field: ui_type Format: `int32`.
`result.data.field_updates[].field.id`	`string`	No	—	Unique ID of the field to be updated. Maximum length: 255.
`result.data.field_updates[].field.api_name`	`string`	No	—	API name of the field to be updated. Maximum length: 255.
`result.data.field_updates[].dependent_fields`	`array`	No	—	Specify the dependent fields that are affected when the target field is updated Maximum items: 1.
`result.data.field_updates[].dependent_fields[].field`	`object`	Yes	—	Specify the API name and the unique ID of the field to be updated.
`result.data.field_updates[].dependent_fields[].field.ui_type`	`integer`	No	—	Field: ui_type Format: `int32`.
`result.data.field_updates[].dependent_fields[].field.id`	`string`	No	—	Unique ID of the field to be updated. Maximum length: 255.
`result.data.field_updates[].dependent_fields[].field.api_name`	`string`	No	—	API name of the field to be updated. Maximum length: 255.
`result.data.field_updates[].dependent_fields[].value`	`string`	Yes	—	Contains value of the dependent field (Required) Maximum length: 255.
`result.data.field_updates[].related_records`	`array \| null`	No	—	Specify the list of related modules (Tasks, Calls and Events) whose ownership should also be updated. Maximum items: 2.
`result.data.field_updates[].related_records[].api_name`	`string`	No	—	API name of the related record. Maximum length: 255.
`result.data.field_updates[].related_records[].id`	`string`	No	—	Unique id of the related rec Maximum length: 255.
`result.data.field_updates[].associated`	`boolean`	No	—	Field: associated
`result.data.field_updates[].name`	`string`	Yes	—	Specify the name of the field update action. (Required) Maximum length: 255.
`result.data.field_updates[].modified_by`	`object`	No	—	Nested schema for modified_by
`result.data.field_updates[].modified_by.name`	`string`	No	—	Field: name Maximum length: 255.
`result.data.field_updates[].modified_by.id`	`string`	No	—	Field: id Maximum length: 255.
`result.data.field_updates[].id`	`string`	No	—	Field: id Maximum length: 255.
`result.data.field_updates[].value`	`record`	Yes	—	Specify the value to set in the specified field. (Required)
`result.data.info`	`object`	No	—	Nested schema for info
`result.data.info.per_page`	`integer`	No	—	Field: per_page Format: `int32`.
`result.data.info.count`	`integer`	No	—	Field: count Format: `int32`.
`result.data.info.page`	`integer`	No	—	Field: page Format: `int32`.
`result.data.info.more_records`	`boolean`	No	—	Field: more_records
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Getting Started

GTM is code

Features

Deepline SDK beta

Integrations

API Reference

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation