Zoho: Pipeline — pipeline replace Pipelines

← Pipeline operations · Get started

Operation zoho.replacepipelines

Provider route: PUT /crm/v8/settings/pipeline. 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"]["replacePipelines"]>[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.replacePipelines(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.replace_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 Pipeline — pipeline update Pipelines — request body — body

Referenced models: Pipeline — pipeline update Pipelines — 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 Pipeline — pipeline create Pipeline — response body

Referenced models: Pipeline — pipeline create Pipeline — response body

Schemas

Pipeline — pipeline create Pipeline — response body

Field	Type	Presence	Description and constraints
$	object	Root	Batch success response for pipeline creation/update operations, maintaining 1:1 correspondence with request items. Additional keys: not allowed
pipeline	array	Required within parent	Array of individual success responses matching the request pipeline items. Maximum items: 1 Minimum items: 1
pipeline[]	object	Each item	Individual success response for a pipeline operation, mirroring the request structure. Additional keys: not allowed
pipeline[].code	string	Required within parent	Represents the success code indicating the type of successful operation. Known values: SUCCESS
pipeline[].details	object	Required within parent	Operation-specific success details including resource identifiers. Additional keys: not allowed
pipeline[].details.id	string	Required within parent	Unique identifier of the newly created pipeline configuration. Format: int64
pipeline[].message	string	Required within parent	Represents the confirmation of the successful operation. Format: string
pipeline[].status	string	Required within parent	Overall status indicator. Known values: success

Pipeline — pipeline update Pipelines — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body for updating or creating pipeline configurations with custom picklist values and stage mappings. Additional keys: not allowed
pipeline	array	Required within parent	Array of pipeline picklist configurations to create or update. Maximum items: 1 Minimum items: 1
pipeline[]	object	Each item	Picklist value configuration for pipeline customization, including stage mappings. Additional keys: not allowed
pipeline[]._delete	object	Optional	Deletion metadata object. Additional keys: not allowed
pipeline[]._delete.permanent	null	Required within parent	Indicates if the deletion was permanent (true), soft delete (false), or status unknown/null.
pipeline[].default	boolean	Optional	Indicates if this picklist value should be set as the default option.
pipeline[].display_value	string	Optional	User-facing display name for the picklist value. Format: string
pipeline[].id	string	Required within parent	ID of the pipeline Format: int64
pipeline[].maps	array	Optional	Array of stage mappings defining which stages this picklist value connects to and their sequence. Maximum items: 200 Minimum items: 1
pipeline[].maps[]	Model	Each item	Expand Pipeline — pipeline update Pipelines — request body — body pipeline item maps item

Referenced models: Pipeline — pipeline update Pipelines — request body — body pipeline item maps item

Pipeline — pipeline update Pipelines — request body — body pipeline item maps item

Field	Type	Presence	Description and constraints
$	object	Root	Mapping configuration for associating a picklist value with a specific pipeline stage. Additional keys: not allowed
_delete	object	Optional	Deletion metadata object. Additional keys: not allowed
_delete.permanent	null	Required within parent	Indicates if the deletion was permanent (true), soft delete (false), or status unknown/null.
display_value	string	Optional	User-facing display name for the pipeline stage. Format: string
id	string	Required within parent	Unique identifier of the target pipeline stage to map. Format: int64
sequence_number	integer	Optional	Optional position of this stage mapping in the pipeline sequence (overrides default positioning). Format: int32

Policy, approvals and errors

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