Zoho: Validate user before transfer

← Users transfer operations · Get started

Operation zoho.getvalidatebeforetransferstatus

Provider route: GET /crm/v8/users/{userId}/actions/validate_before_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"]["getValidateBeforeTransferStatus"]>[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.getValidateBeforeTransferStatus(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_validate_before_transfer_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.userId	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	Represents the response body for the pre-transfer validation request, containing details about the user’s records, assignments, criteria, subordinates, and alerts. Additional keys: not allowed
validate_before_transfer	array	Required within parent	Represents the list of pre-transfer validation results for the specified user. The array contains a maximum of one object. Maximum items: 1
validate_before_transfer[]	object	Each item	Represents the validation details for a single user before transfer. Additional keys: not allowed
validate_before_transfer[].alert	boolean	Optional	Indicates whether alerts exist for the user.
validate_before_transfer[].assignment	boolean	Optional	Indicates whether assignments exist for the user.
validate_before_transfer[].criteria	boolean	Optional	Indicates whether criteria configurations exist for the user.
validate_before_transfer[].id	string	Optional	Represents the unique identifier of the user being validated. Maximum length: 19
validate_before_transfer[].name	string	Optional	Represents the name of the user being validated. Maximum length: 250
validate_before_transfer[].subordinates	boolean	Optional	Indicates whether subordinates exist for the user.

Policy, approvals and errors

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