Zoho: Create Field Update

← Field updates operations · Get started

Operation zoho.createfieldupdates

Provider route: POST /crm/v8/settings/automation/field_updates. 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"]["createFieldUpdates"]>[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.createFieldUpdates(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.create_field_updates(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Optional	Expand Create Field Update — request body — body

Referenced models: Create Field Update — request body — body

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
$	Model	Root	Expand Create Field Update — response body

Referenced models: Create Field Update — response body

Schemas

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

Create Field Update — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The request body wrapper for creating or updating a field update action. Must contain a field_updates array with exactly one entry. Additional keys: not allowed
field_updates	array	Required within parent	Array containing one field update configuration object. Exactly one item is allowed per request. Maximum items: 1
field_updates[]	Model	Each item	Expand Create Field Update — request body — body field updates item

Referenced models: Create Field Update — request body — body field updates item

Create Field Update — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response returned when a field update action is created. Contains an array with a single result object indicating the outcome and the server-generated ID of the new field update. Additional keys: not allowed
field_updates	array	Optional	Array containing the result of the create operation. Always contains exactly one item since only one field update can be created per request. Maximum items: 1
field_updates[]	Model	Each item	Expand Create Field Update — response body — field updates item

Referenced models: Create Field Update — response body — field updates item

Create Field Update — request body — body field updates item

Field	Type	Presence	Description and constraints
$	object	Root	Defines a single field update action, including the target module, target field, mapping type, and the value to apply. Some properties are conditionally required depending on the target field's type — for example, Owner fields require notify and related_records. Additional keys: not allowed
apply_assignment_threshold	boolean	Optional	Whether to enforce assignment-threshold rules when updating the Owner field. This key is applicable only for Owner updates, and is required only when active owner-assignment thresholds exist for the module. If thresholds are not configured, sending this key can be rejected as not allowed. Default: false
dependent_fields	array or null	Optional	Dependent fields that must be set alongside the target field. Required for dependent picklist relationships. Common chains: Pipeline -> Stage, Layout -> Pipeline, and Layout -> Pipeline -> Stage (nested via dependent_fields inside the Pipeline node). Maximum items: 1
dependent_fields[]	Model	Each item	Expand Create Field Update — request body — body field updates item dependent fields item
feature_type	string	Optional	Automation feature where this field update action is used. Supports baseline features plus connected_workflows. No cadence support. The automation feature this field update is associated with. Defaults to 'workflow' if omitted. All enum values are supported for creation via API. One of: workflow, approval_process, blueprint_transition, blueprint_state, assignment_rules, kiosk, commandcenter_service, connected_workflows Maximum length: 255
field	Model	Required within parent	Expand Create Field Update — request body — body field updates item field Target field to be updated. Provide both field.id and field.api_name. If both are present but inconsistent, ambiguity or invalid-data errors can be returned.
module	Model	Required within parent	Expand Create Field Update — request body — body field updates item module The CRM module where this field update should be applied. Specify using the module's unique ID and/or API name (e.g., Deals, Leads, Contacts).
name	string	Required within parent	Name of the field update action. Must be unique within the org. This label is displayed in the automation rule configuration UI. Maximum length: 255
notify	boolean	Optional	Whether to send an email notification to the new owner when the Owner field is updated. Required when the target field is Owner (omitting returns DEPENDENT_FIELD_MISSING). Must not be sent when the target field is not Owner (returns NOT_ALLOWED). Default: false
related_module	Model	Optional	Expand Create Field Update — request body — body field updates item related module Related module context when the field update is configured on a related module's records (e.g., updating a field on Contacts related to Accounts). Pass null or omit when not applicable.
related_records	array or null	Optional	Related modules whose open record ownership should also be transferred when the Owner field is updated. Common activity modules (Tasks, Calls, Events) are available for all modules. Additional modules depend on the parent module: Accounts can also include Contacts and Deals; Contacts can also include Deals. Required when the target field is Owner (omitting returns DEPENDENT_FIELD_MISSING). Must not be sent when the target field is not Owner (returns NOT_ALLOWED). Pass null to skip ownership transfer on related records. Maximum items: 5
related_records[]	Model	Each item	Expand Create Field Update — request body — body field updates item related records item
type	string	Required within parent	The mapping type used when creating or updating the field update action. Only static is accepted; merge_field appears only in GET responses for existing actions. Create/update mapping type. Only static is accepted for create/update payloads. One of: static Maximum length: 255
update_type	Model	Optional	Expand Create Field Update — request body — body field updates item update type Strategy for applying the value. Required for multi-select fields: 'overwrite' replaces all existing values, 'append' adds to them. Omit or pass null for single-value fields.
value	JSON	Required within parent	The value to assign to the target field when this action is triggered. The type must match the target field's data type - a mismatch returns DEPENDENT_MISMATCH. Pipeline expects a string value from Pipelines metadata; Layout expects a layout object from Layouts metadata; Owner expects a user object from Users API.
value (anyOf 1)	string	Alternative	A string value used for text, single-picklist, date, or Pipeline fields. Picklist and Pipeline values are validated against the field's configured options. Maximum length: 255
value (anyOf 2)	Model	Alternative	Expand Create Field Update — request body — body field updates item value array
value (anyOf 3)	Model	Alternative	Expand Create Field Update — request body — body field updates item value id, name
value (anyOf 4)	boolean	Alternative	A boolean value used for checkbox fields, where true marks the field as checked and false marks it as unchecked.
value (anyOf 5)	number	Alternative	A numeric value used for number, currency, decimal, or percentage fields.
value (anyOf 6)	null	Alternative	Null value - clears/empties the target field, removing any previously set value.

Referenced models: Create Field Update — request body — body field updates item dependent fields item, Create Field Update — request body — body field updates item field, Create Field Update — request body — body field updates item value array, Create Field Update — request body — body field updates item value id, name, Create Field Update — request body — body field updates item update type, Create Field Update — request body — body field updates item module, Create Field Update — request body — body field updates item related module, Create Field Update — request body — body field updates item related records item

Create Field Update — response body — field updates item

Field	Type	Presence	Description and constraints
$	object	Root	Result object for a field update create, update, or delete operation. Contains the operation outcome code, a human-readable message, the status, and details including the server-generated ID. Additional keys: not allowed
code	string	Required within parent	Operation result code. 'SUCCESS' for successful operations. In bulk operations (DELETE 207), individual items may return error codes like 'NOT_ALLOWED' or 'INVALID_DATA'. Known values: SUCCESS, NOT_ALLOWED, INVALID_DATA Maximum length: 255
details	Model	Required within parent	Expand Create Field Update — response body — field updates item details
message	string	Required within parent	Human-readable message describing the operation outcome. Maximum length: 255
status	string	Required within parent	Overall status of the operation. 'success' for successful operations, 'error' for failed individual items in bulk operations. Known values: success, error Maximum length: 255

Referenced models: Create Field Update — response body — field updates item details

Create Field Update — request body — body field updates item dependent fields 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 Create Field Update — request body — body field updates item dependent fields item dependent fields item
field	Model	Required within parent	Expand Create Field Update — request body — body 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: Create Field Update — request body — body field updates item dependent fields item dependent fields item, Create Field Update — request body — body field updates item field

Policy, approvals and errors

SDK function policy ID: zoho.createfieldupdates. Catalog operation: createFieldUpdates. 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.

Official provider source