Zoho crm Logo

转移和删除管道

目的

删除一个管道并将相关阶段转移到另一个管道。

端点

  • POST /settings/pipeline/actions/transfer?layout_id={layout_ID}

请求详情

请求 URL

{api-domain}/crm/{version}/settings/pipeline/actions/transfer?layout_id={layout_id}

标题

授权: Zoho-oauthtoken <access_token>

范围

scope=ZohoCRM.settings.pipeline.CREATE
(或)
scope=ZohoCRM.settings.pipeline.ALL

参数
  • layout_id字符串,必填

    创建管道时使用的布局的唯一 ID。

样本请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/pipeline/actions/transfer?layout_id=3652397000000091023"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
请求 JSON
  • pipelineJSON 对象,必填

    要从中转移交易的管道的ID和要转移到的管道的ID。此对象包含以下键:

    • from - 字符串,必填 - 要删除并转移相关交易的管道的ID。
    • to - 字符串,必填 - 要从另一个管道中转移交易到的管道的ID。
  • stagesJSON 数组,必填

    要映射到新的管道中的阶段。此数组包含以下键:

    • from - 字符串,必填 - 要删除的管道中的阶段的ID。
    • to - 字符串,必填 - 要将旧阶段映射到的新管道中的阶段的ID。

示例输入

Copied{
    "transfer_pipeline": [
        {
            "pipeline": {
                "from": "3652397000003712004",
                "to": "3652397000003097007"
            },
            "stages": [
                {
                    "from": "3652397000000006817",
                    "to": "3652397000000006819"
                }
            ]
        }
    ]
}

可能的错误

  • MANDATORY_NOT_FOUNDHTTP 400

    您未在输入中包含 JSON 对象 "pipeline" 或 "stages" 数组。
    解决方法: 包含 "pipeline" JSON 对象和 "stages" 数组,以及所需的键及其值。

  • INVALID_DATAHTTP 400

    布局的ID无效。
    解决方案:请提供一个有效的布局ID。

  • INVALID_DATAHTTP 400

    输入中的 "from" 或 "to" ID 无效。
    解决方法:请参阅响应中的 "details" 键,以获取无效键的 API 名称,并提供有效的输入。

  • REQUIRED_PARAM_MISSINGHTTP 400

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

示例回复

Copied{
    "transfer_pipeline": [
        {
            "code": "SUCCESS",
            "details": {
                "job_id": "3652397000003737002"
            },
            "message": "transfer pipeline scheduled successfully",
            "status": "success"
        }
    ]
}