Zoho: Update records in a specified module

← Record operations · Get started

Operation zoho.updaterecords

Provider route: PUT /crm/v8/{module}. 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["record"]["updateRecords"]>[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.record.updateRecords(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.record.update_records(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.module	string	Required within parent	Maximum length: 25
body	Model	Required within parent	Expand Update records in a specified module — request body — body Request body containing the updated resource data to modify the existing record.

Referenced models: Update records in a specified module — 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
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Record Clone — response body
$ (anyOf 2)	object	Alternative	Represents the multi-status response returned when a bulk operation results in mixed success and failure outcomes. Additional keys: not allowed
$ (anyOf 2).data	array	Required within parent	Contains the list of per-record results for the operation. Maximum items: 100 Minimum items: 2
$ (anyOf 2).data[]	JSON	Each item	Represents a single record operation result, which is either a success or error item identified by the status field.
$ (anyOf 2).data[] (anyOf 1)	Model	Alternative	Expand Record Clone — response body — data item
$ (anyOf 2).data[] (anyOf 2)	Model	Alternative	Expand Update records in a specified module — response body — data data item value
$ (anyOf 2).data (allOf 1)	JSON	All variants apply	Ensures the response contains at least one successful result in the data array.
$ (anyOf 2).data (allOf 2)	JSON	All variants apply	Ensures the response contains at least one failed result in the data array.

Referenced models: Record Clone — response body — data item, Update records in a specified module — response body — data data item value, Record Clone — response body

Schemas

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

Record Clone — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single record post success data result item. Additional keys: not allowed
code	string	Required within parent	Represents the error code identifying the type of failure. Known values: SUCCESS
details	object	Required within parent	Contains additional context about the error. Additional keys: not allowed
details.$approval_state	string	Optional	Contains additional context about the error. Maximum length: 255
details.$approved	boolean	Optional	Contains additional context about the error.
details.$has_more	object	Optional	Contains additional context about the error. Additional keys: allowed
details.$layout_id	object	Optional	Contains additional context about the error. Additional keys: not allowed
details.$layout_id.display_label	string	Optional	Contains additional context about the error. Maximum length: 255
details.$layout_id.id	string	Required within parent	Contains additional context about the error. Format: int64
details.$layout_id.name	string	Optional	Contains additional context about the error. Maximum length: 255
details.$locked_for_me	boolean	Optional	Contains additional context about the error.
details.$process_flow	boolean	Optional	Contains additional context about the error.
details.$state	string	Optional	Contains additional context about the error. Maximum length: 255
details.$status	string	Optional	Contains additional context about the error. Maximum length: 255
details.$wizard_connection_path	JSON	Optional
details.$wizard_connection_path (anyOf 1)	string	Alternative	$wizard_connection_path information denoted by comma separated connection ids between wizard screens. Maximum length: 2000 Read only: false
details.$wizard_connection_path (anyOf 2)	null	Alternative	$wizard_connection_path information denoted by comma separated connection ids between wizard screens. Maximum length: 2000 Read only: false
details.Created_By	object	Required within parent	Contains additional context about the error. Additional keys: not allowed
details.Created_By.id	string	Required within parent	Contains additional context about the error. Format: int64
details.Created_By.name	string	Required within parent	Contains additional context about the error. Maximum length: 101
details.Created_Time	string	Required within parent	Contains additional context about the error. Format: date-time
details.Modified_By	object	Required within parent	Contains additional context about the error. Additional keys: not allowed
details.Modified_By.id	string	Required within parent	Contains additional context about the error. Format: int64
details.Modified_By.name	string	Required within parent	Contains additional context about the error. Maximum length: 101
details.Modified_Time	string	Required within parent	Contains additional context about the error. Format: date-time
details.id	string	Required within parent	Contains additional context about the error. Format: int64
message	string	Required within parent	Represents the error message describing why the operation failed.
status	string	Required within parent	Indicates the overall result status of the request. Known values: success

Update records in a specified module — response body — data data item value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the error response returned when the operation fails due to a record put data item error.
$ (anyOf 1)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Record Invalid Data Type Error
$ (anyOf 2)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Supported Values Error
$ (anyOf 3)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Max Length Error
$ (anyOf 4)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Data Value Error
$ (anyOf 5)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: INVALID MODULE, status: error
$ (anyOf 6)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: MULTIPLE OR MULTI ERRORS, status: error
$ (anyOf 7)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error
$ (anyOf 8)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: DEPENDENT SERVICE ERROR, status: error
$ (anyOf 9)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: MANDATORY NOT FOUND, status: error — Record Mandatory Not Found Error
$ (anyOf 10)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error
$ (anyOf 11)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: INVALID REQUEST METHOD, status: error
$ (anyOf 12)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: AUTHORIZATION FAILED, status: error
$ (anyOf 13)	Model	Alternative	Expand Create records in a specified module — response body — data / data / item / value / code: DUPLICATE DATA, status: error
$ (anyOf 14)	Model	Alternative	Expand Update records in a specified module — response body — data / data / item / value / code: RECORD LOCKED, status: error
$ (anyOf 15)	Model	Alternative	Expand Update records in a specified module — response body — data / data / item / value / code: NOT APPROVED, status: error
$ (anyOf 16)	Model	Alternative	Expand Update records in a specified module — response body — data / data / item / value / code: NOT REVIEWED, status: error

Referenced models: Create records in a specified module — response body — data / data / item / value / code: DEPENDENT SERVICE ERROR, status: error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Data Value Error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Max Length Error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Invalid Supported Values Error, Create records in a specified module — response body — data / data / item / value / code: MULTIPLE OR MULTI ERRORS, status: error, Update records in a specified module — response body — data / data / item / value / code: NOT APPROVED, status: error, Update records in a specified module — response body — data / data / item / value / code: NOT REVIEWED, status: error, Create records in a specified module — response body — data / data / item / value / code: AUTHORIZATION FAILED, status: error, Create records in a specified module — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error, Create records in a specified module — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error, Create records in a specified module — response body — data / data / item / value / code: DUPLICATE DATA, status: error, Create records in a specified module — response body — data / data / item / value / code: INVALID DATA, status: error — Record Invalid Data Type Error, Create records in a specified module — response body — data / data / item / value / code: INVALID MODULE, status: error, Create records in a specified module — response body — data / data / item / value / code: INVALID REQUEST METHOD, status: error, Create records in a specified module — response body — data / data / item / value / code: MANDATORY NOT FOUND, status: error — Record Mandatory Not Found Error, Update records in a specified module — response body — data / data / item / value / code: RECORD LOCKED, status: error

Create records in a specified module — response body — data / data / item / value / code: NOT ALLOWED, status: error details

Field	Type	Presence	Description and constraints
$	object	Root	Contains the contextual details for the invalid data field value error. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field or module. Maximum length: 50
json_path	string	Required within parent	Represents the JSONPath location pointing to the field that caused the error.

Policy, approvals and errors

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