Zoho crm Logo

更新自定义模块

目的

要在您的Zoho CRM账户中更新自定义模块。

端点

  • PUT /settings/modules/{module_ID}
  • PUT /settings/modules/{module_API_name}

请求详情

请求 URL

{api-domain}/crm/{version}/settings/modules/{module_ID}    (或) 
{api-domain}/crm/{version}/settings/modules/{module_API_name}

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

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

样本请求

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

输入 JSON

  • plural_label字符串, 可选

    表示模块的唯一复数名称。最多允许25个字符,包括空格。注意,该字段的值不能为空,并且只支持字母、数字和空格。

  • singular_label字符串, 可选

    表示模块的唯一单数名称。最多允许25个字符,包括空格。注意,该字段的值不能为空,并且只支持字母、数字和空格。

  • profiles字符串, 可选

    指定应该有权访问该模块的角色。至少需要指定一个角色。请参阅获取 Profiles API以检索贵组织中可用的角色。

注意

  • 使用 GET - 模块元数据 API 检索模块的 API 名称和 ID。
  • 模块的 API 名称只能通过界面进行更新。
  • 要创建或更新自定义模块,您需要企业版或更高版本。
  • 一次 API 调用只能更新一个模块。
  • 请为每个模块分配至少一个角色。
  • 更新一个模块将消耗五积分。

示例输入

Copied{
    "modules": [
        {
             "plural_label": "Digital Marketings",
             "singular_label": "Digital Marketing",
            
            "profiles": [
                {
                    "id": "2423488000000015972",
                      "_delete": null
                },
               
                {
                    "id": "2423488000000015975"
                }
            
        ]
    }
]
}

可能的错误

  • INVALID_MODULEHTTP 400

    URL 包含无效的模块数据
    解决方法:请在 URL 中指定正确的 API 名称或模块 ID。请参阅 GET Modules API 以获取模块详细信息。 

  • NOT_ALLOWEDHTTP 400

    模块的 API 名称无法更新
    解决方法:模块 API 名称只能通过界面(UI)进行更新。

  • MINIMUM_DATA_NOT_FOUNDHTTP 400

    至少需要一个配置文件
    解决方法:配置文件键值不能为空或null。请为模块分配至少一个配置文件以进行更新。

  • INVALID_REQUEST_METHODHTTP 400

    HTTP请求方法类型无效
    解决方法:你为访问API URL 指定了一个无效的HTTP方法。
    请指定一个有效的请求方法。请参阅端点部分。

  • MANDATORY_NOT_FOUNDHTTP 400

    必填字段缺失 
    解决方法:请填写所有必填字段以创建自定义模块。更多详情请参阅输入JSON部分。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未授权
    解决方法:客户端没有有效的权限范围来更新自定义模块。请创建具有所需权限范围的新令牌。参见权限范围部分。

  • Authentication_FAILUREHTTP 401

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

  • INVALID_URL_PATTERNHTTP 404

    请检查尝试访问的URL是否正确
    解决方法:请求的URL不正确。请指定有效的请求URL。请参考本页开头的请求URL部分,了解更多详情。

  • INTERNAL_ERRORHTTP 500

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

示例回应

Copied{
    "modules": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "2423488000000834002"
            },
            "message": "module updated successfully",
            "status": "success"
        }
    ]
}