Zoho crm Logo

停用自定义布局

目的

要在您的 Zoho CRM 账户中停用自定义布局。

端点

  • DELETE /settings/layouts/{layout_ID_to_deactivate}/actions/activate?module={module_API_name}&transfer_to={target_layout_ID}

请求详情

请求 URL

{api-domain}/crm/{version}/settings/layouts/{layout_id_to_deactivate}/actions/activate

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

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

参数

  • modulestring,必填

    请指定要停用自定义布局的模块 API 名称。使用 GET Module Metadata API 获取模块 API 名称。支持的模块包括 Leads、Contacts、Accounts、Deals、Products、Quotes、Sales Orders、Purchase、Orders、Invoices、Campaigns、Vendors、Price Books、Cases、Solutions,以及自定义。

  • transfer_tostring,必填

    当前布局关联的默认配置文件必须分配到其他布局。使用 GET Layout Metadata API 获取布局 ID。 

    modules_API_changes

示例请求

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

可能的错误

  • INVALID_DATAHTTP 400
    提供的 transfer_to 布局 ID 无效
    解决方案:请指定有效的布局 ID。使用 GET 布局元数据 API 检索布局 ID。
  • NOT_ALLOWEDHTTP 400
    无法转移到已停用的布局 
    解决方案:  在 "transfer_to" 参数中指定的布局 ID 已被停用。请指定一个处于活动状态的布局 ID。使用 GET 布局元数据 API 来检索唯一的布局 ID。布局元数据 API 的响应中的 status 键指示布局是 active 还是 inactive。
  • ALREADY_DEACTIVATEDHTTP 400
    给定的布局 ID 已经被 deactivated
    解决方案: 请指定一个处于活动状态的布局 ID。使用 获取布局元数据 API 来检索唯一的布局 ID。  来自布局元数据 API 的响应中的 status 键指示布局是 active 还是 inactive ,或者在 fields 参数中使用 "status" 以获取活动布局的列表。

示例响应

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