Zoho: Get user transfer status

← Users transfer operations · Get started

Operation zoho.gettransferapistatus

Provider route: GET /crm/v8/users/actions/transfer. 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["usersTransfer"]["getTransferApiStatus"]>[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.usersTransfer.getTransferApiStatus(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.users_transfer.get_transfer_api_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	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)	object	Alternative	Represents the response body for the transfer status request, containing the current status of the scheduled transfer job. Additional keys: not allowed
$ (anyOf 1).transfer	array	Required within parent	Represents the list of transfer operation status details. The array contains a maximum of one object. Maximum items: 1
$ (anyOf 1).transfer[]	object	Each item	Each object represents the status details of a single transfer operation. Additional keys: not allowed
$ (anyOf 1).transfer[].reason	string	Optional	Represents the failure reason of the job when `status` is `failed`. Not always present. Maximum length: 500
$ (anyOf 1).transfer[].status	string	Optional	Represents the current status of the transfer operation. Possible values: - in_progress - completed - failed - scheduled Known values: in_progress, completed, failed, scheduled
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

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