Zoho: Pipeline schemas

← Pipeline operations · All schemas

Pipeline — pipeline create Pipeline — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body for creating a pipeline configuration with a custom pipeline label and mapped stage values for a specific Deals layout. 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[].default	boolean	Optional	Indicates if this picklist value should be set as the default option.
pipeline[].display_value	string	Required within parent	User-facing display name for the picklist value. Format: string
pipeline[].maps	array	Required within parent	Array of stage mappings defining which stages this picklist value connects to and their sequence. Maximum items: 200 Minimum items: 1
pipeline[].maps[]	object	Each item	Mapping configuration for associating a picklist value with a specific pipeline stage. Additional keys: not allowed
pipeline[].maps[].display_value	string	Optional	User-facing display name for the pipeline stage. Format: string
pipeline[].maps[].id	string	Required within parent	Unique identifier of the target pipeline stage to map. Format: int64
pipeline[].maps[].sequence_number	integer	Optional	Optional position of this stage mapping in the pipeline sequence (overrides default positioning). Format: int32

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 Pipeline By Id — 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[].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

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

Pipelines — response body — pipeline

Field	Type	Presence	Description and constraints
$	object	Root	Root response object containing all pipeline configurations configured for a given Deals layout in Zoho CRM. Additional keys: not allowed
pipeline	array	Required within parent	Array of pipeline configuration items. Maximum items: 90 Minimum items: 1
pipeline[]	Model	Each item	Expand Pipelines — response body — pipeline pipeline item

Referenced models: Pipelines — response body — pipeline pipeline item

Pipelines — response body — pipeline pipeline item

Field	Type	Presence	Description and constraints
$	object	Root	Picklist option representing a pipeline configuration with associated stage mappings. Additional keys: not allowed
actual_value	string	Required within parent	Internal API value for the picklist option. Format: string
default	boolean	Optional	Indicates if this is the default picklist value.
display_value	string	Required within parent	Display name of the picklist value as shown to users. Format: string
id	string	Required within parent	Unique identifier for this picklist value. Format: int64
maps	array	Required within parent	Array of stage mappings for this picklist value. Maximum items: 200 Minimum items: 1
maps[]	Model	Each item	Expand Pipelines — response body — pipeline pipeline item maps item

Referenced models: Pipelines — response body — pipeline pipeline item maps item

Pipelines — response body — pipeline pipeline item maps item

Field	Type	Presence	Description and constraints
$	object	Root	Mapping between a picklist value and a specific pipeline stage, including its position and forecasting details. Additional keys: not allowed
actual_value	string	Required within parent	Internal system value/API name for the stage. Format: string
colour_code	string	Optional	Hexadecimal color code associated with the stage for UI representation. Format: string
display_value	string	Required within parent	User-facing display name of the pipeline stage. Format: string
forecast_category	object	Required within parent	Represents a forecast category used in sales pipeline stages for revenue forecasting and reporting. Additional keys: not allowed
forecast_category.id	string	Required within parent	Unique system identifier for the forecast category. Format: int64
forecast_category.name	string	Required within parent	Represents the name of the forecast category (e.g., 'Pipeline', 'Closed', 'Omitted'). Format: string
forecast_type	string	Required within parent	Forecast type indicating stage status (e.g., 'Open', 'Closed Won', 'Closed Lost'). Format: string
id	string	Required within parent	Unique identifier for this stage mapping. Format: int64
sequence_number	JSON	Required within parent
sequence_number (anyOf 1)	integer	Alternative	Position of this stage in the pipeline sequence (1-based indexing). Format: int32
sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Specific Pipeline — response body — pipeline

Field	Type	Presence	Description and constraints
$	object	Root	Root response object containing an array of pipeline configurations from Zoho CRM. Additional keys: not allowed
pipeline	array	Required within parent	Array of pipeline configuration items. Maximum items: 1 Minimum items: 1
pipeline[]	Model	Each item	Expand Pipelines — response body — pipeline pipeline item

Referenced models: Pipelines — response body — pipeline pipeline item

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

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