Zoho: Get mass update job status

← Mass update operations · Get started

Operation zoho.getmassupdatestatus

Provider route: GET /crm/v8/{module}/actions/mass_update. 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["massUpdate"]["getMassUpdateStatus"]>[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.massUpdate.getMassUpdateStatus(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.mass_update.get_mass_update_status(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	One of: Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Calls, Meetings, Cases, Solutions, Products, Vendors, Price_Books, Quotes, Sales_Orders, Purchase_Orders, Invoices, Custom
query	object	Required within parent	Additional keys: not allowed
query.job_id	string	Required within parent	Format: int64 Pattern: ^[0-9]+$

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
$	object	Root	The request body contains the data required to perform the operation. Additional keys: not allowed
data	array	Required within parent	Represents the array that contains the status object for the requested mass update job. Maximum items: 1
data[]	object	Each item	Represents the status object that contains the current state and processed-record counts for the mass update job. Additional keys: not allowed
data[].Failed_Count	JSON	Required within parent
data[].Failed_Count (anyOf 1)	integer	Alternative	Represents the number of records that failed to update due to validation errors or other processing failures during the mass update job. Format: int32
data[].Failed_Count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data[].Not_Updated_Count	JSON	Required within parent
data[].Not_Updated_Count (anyOf 1)	integer	Alternative	Represents the number of records that are not yet updated by the mass update job. Format: int32
data[].Not_Updated_Count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data[].Status	string	Required within parent	Represents the current state of the mass update job. Possible values: COMPLETED - The mass update job has finished processing all records. SCHEDULED - The mass update job has been queued and is waiting to start. QUEUED - The mass update job is queued in the system. RUNNING - The mass update job is currently processing records. SUSPENDED - The mass update job has been paused. FAILED - The mass update job has terminated due to a failure. Known values: COMPLETED, SCHEDULED, QUEUED, RUNNING, SUSPENDED, FAILED
data[].Total_Count	JSON	Required within parent
data[].Total_Count (anyOf 1)	integer	Alternative	Represents the total number of records that were scheduled to be mass updated by the job. Format: int32
data[].Total_Count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data[].Updated_Count	JSON	Required within parent
data[].Updated_Count (anyOf 1)	integer	Alternative	Represents the number of records that were successfully updated by the mass update job. Format: int32
data[].Updated_Count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

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