Zoho crm Logo

删除自定义布局

目的

要删除自定义布局并将其记录转移到另一个活动布局。

端点

  • DELETE /settings/layouts/{layout_ID}?module={module_API_name}&transfer_to={target_layout_ID}

请求详情

请求 URL

{api-domain}/crm/{version}/settings/layouts/{layout_id}

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.layouts.DELETE   (或)
ZohoCRM.settings.layouts.ALL   (或)
ZohoCRM.settings.ALL 

参数

  • module字符串,必填

    指定要从中删除自定义布局的模块 API 名称。使用 GET 模块元数据 API 获取模块 API 名称。支持的模块包括 Leads, Contacts, Accounts, Deals, Products, Quotes, Sales Orders, Purchase, Orders, Invoices, Campaigns, Vendors, Price Books, Cases, Solutions, 以及 Custom。

  • transfer_to字符串,必填

    指定要将正在删除的布局中的记录和配置文件转移到的布局 ID。使用 GET 布局元数据 API 获取布局 ID。

    modules_API_changes

注意

您可以在一次 API 调用中删除一个自定义布局。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/layouts/5725767000002269121?module=Leads&transfer_to=5725767000002256361"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

可能的错误

  • INVALID_DATAHTTP 400

    提供的布局 ID 似乎无效
    解决方案:请指定一个有效的布局 ID。使用 GET 布局元数据 API 来获取唯一的布局 ID。

  • NOT_ALLOWEDHTTP 400
    • 无法转移到已停用的布局
      解决方法:在 "transfer_to" 参数中指定的布局 ID 已被停用。请指定一个处于启用状态的布局 ID。布局元数据 API 的响应中的 status 键指示布局是 active 还是 inactive。
    • 无法删除系统定义的布局
      解决方法:只有自定义布局可以被删除。请指定自定义布局 ID。使用 GET 布局元数据 API 来检索唯一的布局 ID。对于自定义布局,键 "generated_type" 将被设置为 "custom"。
  • NO_PERMISSIONHTTP 400

    权限被拒绝
    解决方案:  您没有权限删除该布局。请联系您的系统管理员。

  • REQUIRED_PARAM_MISSINGHTTP 400

    缺少必需的 paRAMeter
    解决方案:请指定所有必需的 paRAMeters。请参阅上面的PaRAMeter部分。

示例响应

Copied{
    "layouts": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "5725767000002256447"
            },
            "message": "layout deleted",
            "status": "success"
        }
    ]
}