Zoho crm Logo

更新流水线

目的

要在布局中更新管道。

端点

  • PUT /settings/pipeline/{pipeline_ID}?layout_id={layout_ID}

请求详情

请求 URL

{api-domain}/crm/{version}/settings/pipeline/{pipeline_ID}?layout_id={layout_id}
您也可以在请求体中发送 pipeline ID。

标题

授权:Zoho-oauthtoken <access_token>

范围

scope=ZohoCRM.settings.pipeline.UPDATE

参数
  • layout_id字符串,必填

    流水线所属布局的唯一 ID。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/pipeline/3652397000003097007?layout_id=3652397000000091023"
-X PUT
-d input.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
请求 JSON
  • display_value字符串,必填

    要更新的销售流程名称。此字段接受字母和数字的值。

  • mapsJSON 数组,必填

    销售流程中,交易需经过的不同阶段。该数组包含以下键:

    • sequence_number - 整数,必填 - 阶段显示的顺序。如果该键的值为“1”,则该阶段将最先显示。
    • id - 字符串,必填 - 阶段的唯一ID。可通过 字段元数据 API 获取字段的唯一ID。

示例输入

Copied{
    "pipeline": [
        {
            "display_value": "Pipeline1",
            "default": false,
            "maps": [
                {
                    "display_value": "Qualification",
                    "sequence_number": 2,
                    "actual_value": "Qualification",
                    "id": "3652397000000006801"
                },
                {
                    "display_value": "Needs Analysis",
                    "sequence_number": 1,
                    "actual_value": "Needs Analysis",
                    "id": "3652397000000006803"
                },
                {
                    "display_value": "Value Proposition",
                    "sequence_number": 3,
                    "actual_value": "Value Proposition",
                    "id": "3652397000000006805"
                },
                {
                    "display_value": "Proposal/Price Quote",
                    "sequence_number": 4,
                    "actual_value": "Proposal/Price Quote",
                    "id": "3652397000000006811"
                }
            ]
        }
    ]
}

可能的错误

  • MANDATORY_NOT_FOUND HTTP 400

    您在请求 URL 中未包含流水线 ID。
    解决方法:您必须在 URL 中包含要更新的流水线 ID。

  • INVALID_DATA HTTP 400

    请求正文中的流程 ID 无效。
    解决方法:使用 字段元数据 API 获取各个阶段的唯一 ID。

  • INVALID_DATA HTTP 400

    “maps” 对象中的阶段 ID 无效。
    解决方法: 使用 字段元数据 API 获取阶段的唯一 ID。

  • INVALID_DATA HTTP 400

    请求 URL 中的流水线 ID 无效。
    解决方法:请提供有效的流水线 ID。使用 获取流水线 API 获取流水线 ID。

  • CANNOT_DELETE HTTP 400

    您无法删除流水线的最后一个阶段。
    解决方法: 在删除最后一个阶段之前,请先为流水线添加另一个阶段。

  • REQUIRED_PARAM_MISSING HTTP 400

    您的请求中未包含必填参数“layout_id”。
    解决方法:在请求中指定有效的布局ID。

示例响应

Copied{
    "pipeline": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000003097007"
            },
            "message": "Pipeline updated",
            "status": "success"
        }
    ]
}