创建流水线
目的
创建一个包含多个阶段的流程,交易将依次通过这些阶段。
端点
- POST /settings/pipeline?layout_id={layout_ID}
请求详情
请求 URL
{api-domain}/crm/{version}/settings/pipeline?layout_id={layout_id}
标题
授权: Zoho-oauthtoken <access_token>
范围
scope=ZohoCRM.settings.pipeline.CREATE
参数
- layout_id字符串,必填
必须在其中创建流水线的布局的唯一 ID。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/pipeline?layout_id=3652397000000091023"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"请求 JSON
- display_value字符串,必填
要创建的管道名称。此键接受字母数字值。
- mapsJSON 数组,必填
交易在销售管道中需要经历的不同阶段。该数组包含以下键:
- sequence_number - 整数,必填 - 阶段显示的顺序。如果该键的值为“1”,则该阶段将首先显示。
- id - 字符串,必填 - 阶段的唯一 ID。使用字段元数据 API获取字段的唯一 ID。
示例输入
Copied{
"pipeline": [
{
"display_value": "Pipeline2",
"default": true,
"maps": [
{
"sequence_number": 1,
"id": "3652397000000006815",
"display_value": "Closed Won"
},
{
"sequence_number": 2,
"id": "3652397000000006817",
"display_value": "Closed Lost"
}
]
}
]
}可能的错误
- MANDATORY_NOT_FOUNDHTTP 400
您在输入中未包含键“display_value”(管道的名称)。
解决方案:“display_value”是输入中的必填键。 - INVALID_DATAHTTP 400
"maps" 对象中阶段的 ID 无效。
解决方案: 使用 字段元数据 API 获取各阶段的唯一 ID。 - DUPLICATE_DATAHTTP 400
已存在同名管道。
解决方法:管道名称必须唯一。 - REQUIRED_PARAM_MISSINGHTTP 400
您在请求中未包含必填的 paRAMeter "layout_id"。
解决方案:请在请求中指定有效的布局 ID。
示例响应
Copied{
"pipeline": [
{
"code": "SUCCESS",
"details": {
"id": "3652397000003712004"
},
"message": "Pipeline created",
"status": "success"
}
]
}