Zoho crm Logo

更新用户类型

目的

在门户中更新用户类型的详细信息。

端点

  • PUT /settings/portals/{portal_name}

请求详情

请求 URL

{api-domain}/crm/{version}/settings/portals/{portal_name}/user_type/{user_type_ID}

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope= ZohoCRM.settings.clientportal.ALL
(或)
Scope=ZohoCRM.settings.clientportal.UPDATE

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/portals/ZohoTest17/user_type/1947281000000470169"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X PUT
-d "@inputData.json"
输入 JSON
  • 名称字符串,必填

    您要更新的用户类型名称。

  • personality_module字符串,必填

    门户用户可查看其记录的人格模块的 API 名称。

  • active布尔值,可选

    用户类型的状态。取值为 true 时,该用户类型为激活状态,您可以向该用户类型添加用户。取值为 false 时,该用户类型将以禁用模式创建。该值为默认值。

  • 模块JSON 数组,必填

    这些模块通过查找字段或多选查找字段与个性模块关联。此数组包含以下键,每个JSON对象均与个性模块及相关模块有关。请注意,除了相关模块外,此数组还必须分别包含一个关于个性模块和备注模块的对象。

    • layouts - JSON 数组,必填 - 模块布局的唯一ID。
    • permissions - JSON 对象,必填 - 表示您希望用户在模块中拥有的权限的布尔型键值对。可用的键包括 view(查看)、edit(编辑)、create(创建)。
    • views - JSON 对象,必填 - 用户可访问的视图的ID和类型。type 的可能取值为 custom_view 和 canvas_view。
    • filters - JSON 数组,必填 - 根据其值,门户用户可以通过查找筛选器和多选查找字段查看记录的字段ID。例如,如果您在“交易”模块中添加了两个查找字段,您可以根据希望门户用户查看的记录来选择一个查找字段。
    • id - 字符串,必填 - 模块的ID。
    • fields - JSON 数组,必填 - 本用户类型的用户可访问的字段ID和视图类型(只读: true/false)。请注意,如果布局中的任何字段被标记为必填,则在门户中这些字段不能为只读。
      键 _delete 将从用户类型中删除该字段。
    • shared_type - 字符串,必填 - 表示该模块是私有模块还是公共模块。可选值为 private 和 public。

    对于备注模块,布局、筛选器、视图可以为 null。

输入 JSON

Copied{
    "user_type": [
        {
            "modules": [
                {
                    "id": "1947281000000000125",
                    "permissions": {
                        "edit": true,
                        "create": true
                    },
                    "shared_type": "private",
                    "fields": [
                        {
                            "id": "111118000000003857",
                            "_delete": true,
                            "read_only": true
                        }
                    ]
                }
            ]
        }
    ]
}

可能的错误

  • DUPLICATE_DATAHTTP 400

    原因:

    • 当你想要更新 "filters" 对象中字段的 ID 时,新字段已经关联到该用户类型。
    • 当你想要更新用户类型的 "name" 时,已经存在另一个具有相同名称的用户类型。

    解决方法: "user_type.modules.filters.id" 和 "name" 必须为唯一值。

  • INVALID_DATAHTTP 400

    原因:

    • 在 "filters" 键中提到的字段 ID 与您要为其创建用户类型的人格模块无关。
    • 当您想要更新用户类型的 "name" 时,已经存在另一个同名的用户类型。
    • 您将 "view" 的值设置为 false。该模块必须拥有 "view" 权限。
    • 您在 "views" 对象中给出的自定义视图或画布视图的 ID 不属于该模块。
    • 您在 "filters" 键中给出的字段 ID 与人格模块无关。
    • 当您更改用户类型时,旧用户类型的相关模块并不是新用户类型的相关模块。在这种情况下,您必须仅输入新用户类型相关模块的详细信息。
    • 您将布局中的必填字段在用户类型中设置为只读。当布局中的字段为必填时,必须将该字段设置为可编辑,供该用户类型的用户使用。
  • CANNOT_REMOVEHTTP 400

    您正在尝试从用户类型中移除布局、必填字段或模块。
    解决方法: 至少一个布局的详细信息、个性模块(即您为其创建用户类型的模块)和“备注”模块是必需的。您还必须在 "fields" 数组中包含布局的必填字段的详细信息。

  • INVALID_MODULEHTTP 400

    原因:

    • 您尝试添加的模块详情与性格模块无关。
    • 该模块设置为公开,但输入中的 shared_type 为私有。

    解决方法:请确保仅提供相关模块的详情,并且对于公开模块,将 shared_type 设置为公开。

  • DEPENDENT_FIELD_MISSINGHTTP 400

    布局 ID 或视图的 ID 缺失。
    解决方法:请参考响应中的 details 键,以了解输入中缺失的相关依赖字段的详细信息。

  • NOT_ACTIVE_PERSONALITY_MODULEHTTP 400

    您尝试为其创建用户类型的人格模块处于非激活状态。
    解决方法:请激活该模块后重试。

  • INVALID_REQUESTHTTP 400

    请确保您已指定有效的参数、对应的值,以及URL。

  • INVALID_REQUEST_METHODHTTP 400

    HTTP 方法无效。
    解决方法:更新用户类型的 HTTP 方法应为 PUT。

Copied{
    "user_type": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "1947281000000470169"
            },
            "message": "Portal user type updated successfully.",
            "status": "success"
        }
    ]
}