Zoho: Get scheduled territory run rule job status

← Territories operations · Get started

Operation zoho.getterritoryscheduledrunrulejobs

Provider route: GET /crm/v8/settings/territories/actions/scheduled_run_rule_jobs. 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["territories"]["getTerritoryScheduledRunRuleJobs"]>[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.territories.getTerritoryScheduledRunRuleJobs(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.territories.get_territory_scheduled_run_rule_jobs(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	Unique identifier of the scheduled run rule job. Format: int64

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 scheduled territory run rule job status — response body — scheduled run rule jobs
$ (anyOf 2)	null	Alternative

Referenced models: Get scheduled territory run rule job status — response body — scheduled run rule jobs

Schemas

Get scheduled territory run rule job status — response body — scheduled run rule jobs

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response containing the status and details of scheduled territory run rule jobs. Additional keys: not allowed
scheduled_run_rule_jobs	object	Required within parent	Represents the status and details of the scheduled territory rule execution job. Additional keys: not allowed
scheduled_run_rule_jobs.job_id	string	Required within parent	Represents the unique identifier of the scheduled run rule job. Format: int64
scheduled_run_rule_jobs.scheduled_by	object	Required within parent	Represents the user who scheduled the run rule job. Additional keys: not allowed
scheduled_run_rule_jobs.scheduled_by.id	string	Required within parent	Represents the unique identifier of the user who scheduled the run rule job. Format: int64
scheduled_run_rule_jobs.scheduled_by.name	string	Required within parent	Represents the name of the user who scheduled the run rule job. Maximum length: 100
scheduled_run_rule_jobs.scheduled_time	string	Required within parent	Represents the date and time when the run rule job was scheduled, in ISO 8601 format. Format: date-time
scheduled_run_rule_jobs.status	string	Required within parent	Represents the current status of the scheduled run rule job. Possible values: **COMPLETED**, **IN_PROGRESS**, **FAILED**, **SCHEDULED**. Known values: COMPLETED, IN_PROGRESS, FAILED, SCHEDULED

Policy, approvals and errors

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