创建全局选取列表
目的
要创建一个全局集合,在您的 Zoho CRM 账户中。
端点
- POST /settings/global_picklists
请求详情
请求 URL
{api-domain}/crm/{version}/settings/global_picklists
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.global_picklist.CREATE
(或)
ZohoCRM.settings.global_picklist.ALL
支持的模块
线索、联系人、Account、市场活动、工单、Invoices、商机、价目表、产品、Purchase Orders、报价单、Sales Orders、解决方案、Vendors、通话、任务、事件、Users、商机历史、已报价Items、OrderItems、采购Items、InvoiceItems、拜访、服务、预约,以及自定义模块。
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/global_picklists"
-X POST
-d "@input.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
输入 JSON
- display_label字符串,必填
全局选项列表的唯一名称,将显示在 CRM 界面中。最多允许50个字符。
- 描述字符串,可选
表示全局选项列表的描述。最多允许1000个字符。
- pick_list_values_sorted_lexically布尔值,可选
它表示对全局集合值的排序偏好。
可能的取值:- false - 按给定顺序(默认值)
- true - 按字母顺序
- pick_list_valuesJSON 数组,必填
包括全局设置选项的详细信息。
- display_value字符串,必填
在CRM界面中为特定值显示的唯一标签。最多允许使用120 个字符。
请注意,表情符号和特殊字符 或空值在显示值中不允许。 - sequence_number整数,可选
它表示某个值在一组选项列表中的位置。默认情况下,顺序将基于用户的输入。请参阅示例输入以供参考。
- reference_value整数,可选
它表示某个特定选项的唯一参考值。请注意,在参考值中不允许使用表情符号和特殊字符。默认情况下,将使用显示值作为参考值。最多允许120 个字符。
- 类型字符串,可选
它表示该选项是已使用还是未使用。type 的默认值为 used。最多允许 1000 个已使用的选项,最多允许 500 个未使用的选项。
注意
- 您可以创建一个全局集合,且只需一次 API 调用。一个组织最多可用的全局集合数量取决于 Zoho CRM Edition。请参阅 Zoho CRM Editions 的功能对比以获取更多信息。
- 默认情况下,系统会将 display_value 键的值赋给 actual_value。您无法手动为 actual_value 指定值。
样例输入
Copied{
"global_picklists": [
{
"display_label": "Source",
"description": "Use this picklist option across all modules in your account.",
"pick_list_values_sorted_lexically": false,
"pick_list_values": [
{
"display_value": "Cold Call",
"sequence_number": 2,
"reference_value": "Call",
"type": "used"
},
{
"display_value": "Twitter",
"sequence_number": 15,
"reference_value": "Tweet",
"type": "used"
},
{
"display_value": "Facebook",
"sequence_number": 16,
"reference_value": "Face_book",
"type": "unused"
},
{
"display_value": "Google+",
"sequence_number": 3,
"reference_value": "Google+",
"type": "used"
}
]
}
]
}可能的错误
- INVALID_DATAHTTP 400
- display_label 包含表情符号或为 null
- 显示标签、实际标签或描述已超出其限制
解决方案:
- 显示值中不允许使用表情符号和特殊字符。请提供有效的非空值。
- 确保 display_label、actual_label 和 description 的值符合指定的限制。有关更多信息,请参阅请求 JSON部分。
- MANDATORY_NOT_FOUNDHTTP 400
缺少一个或多个必填字段
解决方法: 在输入中指定所有必填字段。有关更多信息,请参阅请求 JSON部分。
- LIMIT_EXCEEDEDHTTP 400
- 选取列表中的值已达到上限
- 已达到已用或未用选项的限制。
- 超出全局选取列表的限制
解决方法:
- 对于一个全局集合,最多可添加 1000 个已用选项和 500 个未用选项。请确保您的全局集合选项在其限制范围内。
- 您已为组织创建了允许的最大数量的全局集合。 请在此处查看您所用Edit版本的限制。有关更多信息,请参阅按功能分类的 Zoho CRM Edit版本对比。
- DUPLICATE_DATAHTTP 400
- 重复的 display_label
- 在选择列表选项中发现重复的 display_value
解决方法:
- 确保全局集合的 display_label 为唯一值。
- 确认选择列表选项中的每个 display_value 都是唯一的。
- INVALID_REQUEST_METHODHTTP 400
该 https 请求方法类型无效
解决方法:您为访问 API URL 指定了无效的 HTTP 方法。
请指定有效的请求方法。有关更多详细信息,请参阅端点部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未授权
解决方案: 客户端没有创建全局选取列表所需的有效作用域。请使用所需的作用域创建一个有效的令牌。有关更多详细信息,请参阅作用域 部分。 - Authentication_失败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 added successfully",
"status": "success"
}
]
}