创建用户类型
目的
要在门户中创建一个用户类型。
端点
- POST /settings/portals/{portal_name}/user_type
请求详情
请求 URL
{api-domain}/crm/{version}/settings/portals/{portal_name}/user_type
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope= ZohoCRM.settings.clientportal.ALL
(或)
Scope=ZohoCRM.settings.clientportal.CREATE
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/portals/portals/ZohoTest17/user_type"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"输入 JSON
- name string,必填
您要创建的用户类型的名称。
- personality_module string,必填
其记录可被门户用户查看的 personality 模块的 API 名称。
- active boolean,可选
用户类型的状态。值为 true 时,会激活此用户类型,您可以将用户添加到该用户类型中。值为 false 时,将以禁用模式创建该用户类型。这是默认值。
- 模块JSON array,必填
通过查找或多选查找字段与 personality 模块关联的模块。该数组包含以下键,其中每个 JSON 对象都与 personality 模块及相关模块有关。请注意,除了相关模块外,该数组还必须分别包含一个用于 personality 模块和 Notes 模块的对象。
- 布局 - JSON 数组,必填 - 模块布局的唯一 ID。
- permissions - JSON 对象,必需 - 布尔键值对,用于表示你希望用户在该模块中拥有的权限。可能的键为 view、edit、create。
- views - JSON 对象,必需 - 用户可访问的视图的 ID 和 type。type 的可能取值为 custom_view 和 canvas_view。
- filters - JSON 数组,必填 - 字段的 ID。门户用户将通过使用查找筛选器和多选查找字段,基于该字段的值查看记录。例如,如果您在交易模块中添加了两个查找字段,您可以根据希望门户用户查看的记录选择其中一个查找字段。
- id - 字符串,必填 - 模块的 ID。
- fields - JSON 数组,必填 - 该用户类型的用户可以访问的字段的 ID 和视图类型(只读:true/false)。请注意,如果布局中的任何字段被标记为必填,则该字段在门户中不能设为只读。
- shared_type - 字符串,必填 - 表示该模块是私有模块还是公共模块。可能的取值为 private 和 public。
对于 Notes 模块,layout、filter、view 可以为 null。
Input JSON
Copied{
"user_type": [
{
"name": "lead",
"personality_module": {
"api_name": "Leads"
},
"active": true,
"modules": [
{
"layouts": [
{
"id": "1947281000000095055"
}
],
"permissions": {
"view": true
},
"views": {
"id": "1947281000000091501",
"type": "custom_view"
},
"filters": null,
"fields": [
{
"id": "1947281000000003857",
"read_only": false
}
],
"id": "1947281000000000125",
"shared_type": "private"
},
{
"layouts": null,
"permissions": {
"view": true
},
"views": null,
"filters": null,
"id": "1947281000000000147",
"shared_type": "private"
}
]
}
]
}可能的错误
- DEPENDENT_FIELD_MISSINGHTTP 400
您未在输入的 modules JSON 数组中指定 layout 键。
解决方案:每个私有模块应至少包含一个 layout。 - NOT_ALLOWEDHTTP 400
给定的布局不包含指定的筛选器。
解决方案: 确保在 "filter" 键中指定的字段属于该布局。 - REQUIRED_PARAM_MISSINGHTTP 400
在输入中缺少一个或多个必需参RAM数。
解决方案:响应中的 "details" 键会给出输入中缺失的键。您也可以参阅输入 JSON 部分,确保输入中包含所有标记为 "mandatory" 的键。 - INVALID_DATAHTTP 400
该字段在 Portals 中不被允许。
解决方法:响应中的“details”键会提供在 Portals 中不被允许的字段的路径。移除该字段,并使用允许的字段重试。 - LICENSE_LIMIT_EXCEEDEDHTTP 400
您已超出门户用户许可限制。
解决方法:每个组织最多只能添加 5 种用户类型。请联系 support@zohocrm.com 购买更多用户许可。
示例响应
Copied{
"user_type": [
{
"code": "SUCCESS",
"details": {
"id": "1947281000000470169"
},
"message": "user type created successfully.",
"status": "success"
}
]
}