Zoho: Get mass convert job status

← Mass convert operations · Get started

Operation zoho.getmassconvertjobstatus

Provider route: GET /crm/v8/Leads/actions/mass_convert. 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["massConvert"]["getMassConvertJobStatus"]>[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.massConvert.getMassConvertJobStatus(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_convert.get_mass_convert_job_status(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.job_id	string	Required within parent	Maximum length: 255

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	Represents the successful response for a mass convert job status request, containing a data array of job status entries. Additional keys: not allowed
data	array	Required within parent	Represents the list of job status objects for the scheduled mass convert job. Maximum items: 5
data[]	object	Each item	Represents a single job status entry containing conversion counts and the current processing status of the mass convert job. Additional keys: not allowed
data[].Converted_Count	JSON	Required within parent
data[].Converted_Count (anyOf 1)	integer	Alternative	Represents the number of leads that were successfully converted in the job. Format: int32
data[].Converted_Count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data[].Failed_Count	JSON	Required within parent
data[].Failed_Count (anyOf 1)	integer	Alternative	Represents the number of leads for which conversion failed. Format: int32
data[].Failed_Count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data[].Not_Converted_Count	JSON	Required within parent
data[].Not_Converted_Count (anyOf 1)	integer	Alternative	Represents the number of leads that have not yet been converted. Format: int32
data[].Not_Converted_Count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data[].Status	string	Required within parent	Indicates the current processing status of the mass convert job. Possible values: completed - The job finished processing all scheduled leads. scheduled - The job is queued for execution. in progress - The job is currently running. failed - The job did not complete. Maximum length: 50
data[].Total_Count	JSON	Required within parent
data[].Total_Count (anyOf 1)	integer	Alternative	Represents the total number of leads scheduled for conversion in the job. Format: int32
data[].Total_Count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

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