Zoho crm Logo

更新全局选项集

目的

要在您的ZohoCRM账户中更新全局选项列表或全局集合。

端点

  • PATCH /settings/global_picklists/{global_picklist_ID}

请求详情

请求 URL

{api-domain}/crm/{version}/settings/global_picklists/{global_picklist_ID}

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.global_picklist.UPDATE 
(或)
ZohoCRM.settings.global_picklist.ALL

支持的模块

潜在客户、联系人、Account、市场活动、案例、Invoices、商机、价格表、产品、Purchase Orders、报价单、SalesOrders、解决方案、Vendors、电话、任务、活动、Users、成交记录、报价Items、OrderItems、采购Items、发票Items、拜访、服务、预约,以及自定义模块。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/global_picklists/2423488000000725001"
-X PATCH
-d "@input.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

输入 JSON

  • display_label字符串,必填

    全局选项列表的唯一名称,将显示在CRM界面中。最多允许50个字符。

  • 描述字符串,可选

    表示全局选项列表的描述。最多允许1000个字符。

  • pick_list_values_sorted_lexically布尔值,可选

    它表示全局集合值的排序偏好。

    可能的取值:

    • true - 按字母顺序排序
    • false - 按给定顺序排序
  • pick_list_valuesJSON 数组,必填

    包含全局集合中不同值的详细信息。

    • display_value字符串, 可选

      在CRM界面中为特定数值显示的唯一标签。最多允许120个字符。
      请注意,表情符号和特殊字符不允许出现在显示值中。当您创建新选项时,此键是必填项。

    • reference_value字符串,可选

      它代表与特定选项相关联的唯一参考值。请注意,表情符号和特殊字符在显示值中不允许使用。

    • id字符串,必填

      它代表选项的唯一ID。在使用选项时该字段为必填项。请使用GET - 全局选项列表API获取选项ID。

    • sequence_number整数, 可选

      它表示一个值在选项列表中的位置。

    • 类型字符串,可选

      表示该选项是否被使用。最多允许1000 个已使用选项,最多允许500 个未使用选项。

注意事项

  • 您可以使用此 API 创建新选项,或更新、删除全局选项列表中已有的选项。
  • 默认情况下,系统会将display_value 键的值赋给 actual_value,您无法手动指定 actual_value 的值。
  • 要更新选项列表中的某个值,您必须提供该选项的 ID。
  • 当全局选项列表已被安排删除时,不能更新其中的选项。
  • 您每次 API 调用只能删除一个选项。请注意,无法删除与 蓝图、工作流 等功能相关联的选项。
  • 与 创建记录、工作流、ABM 映射和 流程相关联的选项无法从已用状态 移动到未用状态。
  • 与 字段更新、创建记录、工作流、ABM 映射和 流程相关联的选项无法被删除。
  • 一个全局选项列表最多可以有 1000 个已用选项和 500 个未用选项。

示例输入

Copied{
    "global_picklists": [
        {
            "display_label": "Source1",
            "description": "desc1",
            "pick_list_values_sorted_lexically": true, // to change the order to alphabetical order
            "pick_list_values": [
                {
                    "display_value": "Advertisement1", // updating the picklist display value
                    "sequence_number": 2, // updating the order of picklist value
                    "reference_value": "Advertisement1", // to change the picklist reference value
                    "id": "211111000000055940", // updating picklist id 
                    "type": "used" // to move the option to used state
                },
                {
                    "display_value": "Cold Call1",
                    "sequence_number": 2,
                    "id": "211111000000055942", // picklist id to be updated
                    "type": "unused" // to move the option to unused state
                },
                {
                    "display_value": "Cold Call2",
                    "sequence_number": 3,
                    "id": "211111000000051285",
                    "type": "unused",
                    "_delete": null // deleting the option from the global picklist
                },
                {
                    // to create new option id 
                    "display_value": "Employee 33",
                    "sequence_number": 1
                }
            ]
        }
    ]
}

可能的错误

  • INVALID_DATAHTTP 400
    • display_label 包含表情符号或为空
    • 提供的全局选项集 ID 似乎无效

    解决方法:

    • 显示值中不允许包含表情符号和特殊字符。请指定一个有效且非空的值。
    • 请为全局选项集指定有效的唯一 ID。使用 获取全局选项集 API 来获取全局选项集的唯一 ID 及其关联的选项 ID。
  • LIMIT_EXCEEDEDHTTP 400
    • 选项列表中的值已达到上限
    • 已用或未用选项的数量已达上限。
    • 全局选项列表已超出限制

    解决方案:

    • 对于一个全局集合,最多可以添加1000个已用选项和500个未用选项。请确保您的全局集合选项未超过其限制。
    • 您已为您的组织创建了可用的全局集合数量的上限。如需了解您的Edit的相关限制,请参考此处。更多信息请参阅各Zoho CRM Edit功能对比表。
  • DUPLICATE_DATAHTTP 400
    • 重复的 display_label
    • 在选项列表中发现了重复的 display_value

    解决方法:

    • 确保全局集合的 display_label 为唯一值。
    • 验证每个选项列表中的 display_value 都是唯一的。
  • MANDATORY_NOT_FOUNDHTTP 400

    缺少一个或多个必填字段

    解决方法:要更新全局选项列表中的某个选项,您必须提供其对应的ID或显示值(display_value)。

  • NOT_ALLOWEDHTTP 400

    全局选项列表正在删除中

    解决方法:在全局选项列表处于删除过程中,无法进行更新。请指定一个有效的全局选项列表进行更新。

  • INVALID_REQUEST_METHODHTTP 400

    https 请求方法类型无效
    解决方法: 您为访问 API URL 指定了无效的 HTTP 方法。请指定有效的请求方法。请参考上面的端点部分。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未授权
    解决方法:客户端没有用于创建全局选项列表的有效权限范围。请创建具有所需权限范围的有效令牌。请参阅上面的权限范围部分。

  • AUTHENTICATION_FAILURE HTTP 401

    Authentication失败
    解决方法:在 API 请求头中传递访问令牌。

  • INVALID_URL_PATTERNHTTP 404

    请检查您尝试访问的URL是否正确
    解决方法:所指定的请求URL不正确。请指定一个有效的请求URL。 请参考上方请求URL部分。

  • INTERNAL_ERRORHTTP 500

    服务器内部错误
    解决方法:服务器中出现了意外且未处理的异常。请联系支持团队。

示例回复

Copied{
    "global_picklists": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "2423488000000725001"
            },
            "message": "global picklist updated successfully",
            "status": "success"
        }
    ]
}