Zoho: Transfer Pipeline

← Pipeline operations · Get started

Operation zoho.transferanddeletepipelines

Provider route: POST /crm/v8/settings/pipeline/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["pipeline"]["transferAndDeletePipelines"]>[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.pipeline.transferAndDeletePipelines(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.pipeline.transfer_and_delete_pipelines(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.layout_id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
body	Model	Required within parent	Expand Transfer Pipeline — request body — body

Referenced models: Transfer Pipeline — request body — body

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
$	Model	Root	Expand Transfer Pipeline — response body

Referenced models: Transfer Pipeline — response body

Schemas

Transfer Pipeline — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response for pipeline transfer scheduling operation with job tracking information. Additional keys: not allowed
transfer_pipeline	array	Required within parent	Array of pipeline transfer scheduling results maintaining 1:1 correspondence with request. Maximum items: 1 Minimum items: 1
transfer_pipeline[]	object	Each item	Individual pipeline transfer scheduling result. Additional keys: not allowed
transfer_pipeline[].code	string	Required within parent	Represents the success code indicating the type of successful operation. Known values: SUCCESS
transfer_pipeline[].details	object	Required within parent	Success details including the scheduled job identifier. Additional keys: not allowed
transfer_pipeline[].details.job_id	string	Required within parent	Unique identifier of the scheduled pipeline transfer job for tracking. Format: int64
transfer_pipeline[].message	string	Required within parent	Represents the confirmation of the pipeline transfer scheduling. Format: string
transfer_pipeline[].status	string	Required within parent	Overall status indicator. Known values: success

Transfer Pipeline — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Response confirming pipeline transfer operation with source-to-target mappings for pipeline and stages. Additional keys: not allowed
transfer_pipeline	array	Required within parent	Array of pipeline transfer mappings showing source and target configurations. Maximum items: 1 Minimum items: 1
transfer_pipeline[]	object	Each item	Individual pipeline transfer mapping. Additional keys: not allowed
transfer_pipeline[].pipeline	object	Required within parent	Pipeline-level transfer mapping from source to target pipeline. Additional keys: not allowed
transfer_pipeline[].pipeline.from	string	Required within parent	Source pipeline ID. Format: int64
transfer_pipeline[].pipeline.to	string	Required within parent	Target pipeline ID. Format: int64
transfer_pipeline[].stages	array	Required within parent	Array of stage mappings showing which stages transferred to which target stages. Maximum items: 200 Minimum items: 1
transfer_pipeline[].stages[]	object	Each item	Individual stage transfer mapping. Additional keys: not allowed
transfer_pipeline[].stages[].from	string	Required within parent	Source stage ID. Format: int64
transfer_pipeline[].stages[].to	string	Required within parent	Target stage ID. Format: int64

Policy, approvals and errors

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