Zoho: Get Field Update By Id

← Field updates operations · Get started

Operation zoho.getfieldupdatebyid

Provider route: GET /crm/v8/settings/automation/field_updates/{id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["fieldUpdates"]["getFieldUpdateById"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.fieldUpdates.getFieldUpdateById(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.field_updates.get_field_update_by_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Maximum length: 255
query	object	Optional	Additional keys: not allowed
query.include_inner_details	string	Optional	One of: field_label, enable_colour_code, pick_list_values.colour_code, data_type, display_value

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Get Field Update By Id — response body — field updates
$ (anyOf 2)	null	Alternative

Referenced models: Get Field Update By Id — response body — field updates

Schemas

2 more schemas are linked from the tables above, on the schema pages.

Get Field Update By Id — response body — field updates

Field	Type	Presence	Description and constraints
$	object	Root	Response payload for retrieving a single field update action by ID. Additional keys: not allowed
field_updates	array	Optional	Array containing the matched field update action. Contains one item for a valid ID. Maximum items: 1
field_updates[]	Model	Each item	Expand Get Field Update By Id — response body — field updates field updates item

Referenced models: Get Field Update By Id — response body — field updates field updates item

Get Field Update By Id — response body — field updates field updates item created by

Field	Type	Presence	Description and constraints
$	object	Root	User who created the field update action, including display name and unique identifier. Additional keys: not allowed
id	string	Optional	Unique identifier of the user who created the resource. Maximum length: 255
name	string	Optional	Display name of the user who created the resource. Maximum length: 255

Get Field Update By Id — response body — field updates field updates item lock status

Field	Type	Presence	Description and constraints
$	object	Root	Indicates whether a particular component is locked, affecting its editability and deletability. Additional keys: not allowed
locked	boolean	Optional	True when the action is locked and cannot be edited or deleted.

Get Field Update By Id — response body — field updates field updates item modified by

Field	Type	Presence	Description and constraints
$	object	Root	User who last modified the field update action, including display name and unique identifier. Additional keys: not allowed
id	string	Optional	Unique identifier of the user who last modified the resource. Maximum length: 255
name	string	Optional	Display name of the user who last modified the resource. Maximum length: 255

Create Field Update — request body — body field updates item module

Field	Type	Presence	Description and constraints
$	object	Root	Module metadata for the primary CRM module associated with the field update action. Additional keys: not allowed
api_name	string	Required within parent	CRM module API name used in automation configuration (e.g., Leads, Contacts, Deals). Maximum length: 255
id	string	Optional	Unique identifier of the CRM module corresponding to api_name. Maximum length: 255
moduleName	string	Optional	Internal module name. Present only in responses. Maximum length: 255
plural_label	string	Optional	Plural display label of the module (e.g., Deals, Leads). Present only in responses. Maximum length: 255
singular_label	string	Optional	Singular display label of the module (e.g., Deal, Lead). Present only in responses. Maximum length: 255

Get Field Update By Id — response body — field updates field updates item dependent fields null item

Field	Type	Presence	Description and constraints
$	object	Root	A dependent field that must be included alongside the target field's value, used when the target field's valid options depend on another field (for example, Pipeline requires Stage). Supports nesting up to 3 levels. Additional keys: not allowed
dependent_fields	array	Optional	Nested dependent fields that must be set when the current dependent field itself has further dependencies. Maximum items: 10
dependent_fields[]	Model	Each item	Expand Get Field Update By Id — response body — field updates field updates item dependent fields null item dependent fields item
field	Model	Required within parent	Expand Get Field Update By Id — response body — field updates field updates item field Specify the API name and ID of the dependent field to be updated.
value	string	Required within parent	Contains value of the dependent field. Maximum length: 255

Referenced models: Get Field Update By Id — response body — field updates field updates item dependent fields null item dependent fields item, Get Field Update By Id — response body — field updates field updates item field

Get Field Update By Id — response body — field updates field updates item field

Field	Type	Presence	Description and constraints
$	object	Root	Identifies the target field to update. Requires both id and api_name; if they refer to different fields, the request fails with AMBIGUITY_DURING_PROCESSING. Additional keys: not allowed
api_name	string	Required within parent	API name of the CRM field (e.g., Deal_Name, Pipeline, Owner, Layout, Multi_Select_1). Maximum length: 255
data_type	string	Optional	Data type of the CRM field, for example text, picklist, or lookup. Maximum length: 255
field_label	string	Optional	Display label of the CRM field, as shown in the CRM UI. Maximum length: 255
id	string	Required within parent	Unique identifier of the CRM field. Mandatory in create/update payloads. Maximum length: 255
ui_type	JSON	Optional
ui_type (anyOf 1)	integer	Alternative	Internal UI type code for the field. Present only in response; not required in requests. Format: int32
ui_type (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Field Update By Id — response body — field updates field updates item update type

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Specifies how the new value is applied to a multi-select picklist or Owner field: overwrite replaces the existing value, append adds to the existing entries. Omit or set to null for single-value fields. Known values: overwrite, append Maximum length: 255
$ (anyOf 2)	null	Alternative	Specifies how the new value is applied to a multi-select picklist or Owner field: overwrite replaces the existing value, append adds to the existing entries. Omit or set to null for single-value fields. Known values: overwrite, append Maximum length: 255

Get Field Update By Id — response body — field updates field updates item related module

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Related module metadata for automation contexts that operate on related records. Null when no related module context applies. Additional keys: not allowed
$ (anyOf 1).api_name	string	Optional	CRM related-module API name used in automation configuration (e.g., Notes). Maximum length: 255
$ (anyOf 1).id	string	Optional	Unique identifier of the related CRM module corresponding to api_name. Maximum length: 255
$ (anyOf 2)	null	Alternative	Related module metadata for automation contexts that operate on related records. Null when no related module context applies. Additional keys: not allowed
$ (anyOf 2).api_name	string	Optional	CRM related-module API name used in automation configuration (e.g., Notes). Maximum length: 255
$ (anyOf 2).id	string	Optional	Unique identifier of the related CRM module corresponding to api_name. Maximum length: 255

Get Field Update By Id — response body — field updates field updates item related records null item

Field	Type	Presence	Description and constraints
$	object	Root	Identifies a related module whose open records' ownership should be transferred alongside the parent record when the Owner field is updated. Available modules depend on the parent module context. Additional keys: not allowed
api_name	string	Required within parent	API name of the related module. Events, Calls, Tasks - open activity records, available for all modules. Contacts - available only when the parent module is Accounts. Deals - available when the parent module is Accounts or Contacts. Known values: Events, Calls, Tasks, Contacts, Deals Maximum length: 255
id	string	Optional	Unique identifier of the related module. This is the module ID corresponding to the api_name. Maximum length: 255

Get Field Update By Id — response body — field updates field updates item dependent fields null item dependent fields item

Field	Type	Presence	Description and constraints
$	object	Root	Second-level dependent field in a chained dependency. Example: Stage in a Pipeline -> Stage chain. Additional keys: not allowed
dependent_fields	array	Optional	Third-level dependent fields for deeper dependency chains. Maximum items: 10
dependent_fields[]	Model	Each item	Expand Get Field Update By Id — response body — field updates field updates item dependent fields null item dependent fields item dependent fields item
field	Model	Required within parent	Expand Get Field Update By Id — response body — field updates field updates item field Specify the API name and ID of the dependent field to be updated.
value	string	Required within parent	Contains value of the dependent field. Maximum length: 255

Referenced models: Get Field Update By Id — response body — field updates field updates item dependent fields null item dependent fields item dependent fields item, Get Field Update By Id — response body — field updates field updates item field

Policy, approvals and errors

SDK function policy ID: zoho.getfieldupdatebyid. Catalog operation: getFieldUpdateById. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source