Zoho crm Logo

更新角色

目的

要更新您组织中某个角色的详细信息。

  • PUT /settings/roles
  • PUT /settings/roles/{role_ID}

请求详情

请求 URL

{api-domain}/crm/{version}/settings/roles

要更新指定角色:
{api-domain}/crm/{version}/settings/roles/{role_ID}

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.设置.角色.{operation_type}

可能的操作类型

全部 - 完全访问角色数据
Update - Update角色数据

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/roles"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

请求 JSON

  • id字符串,如果请求中未指定则为必填项 URL

    表示要更新的角色的唯一ID。

  • 名称字符串,可选

    表示该角色的显示名称。

  • reporting_toJSON 对象, 可选

    表示在角色层级中高于当前角色的唯一ID和名称。

  • description字符串,可选

    表示该角色的描述(如有)。

  • share_with_peers布尔值,可选

    表示当前角色的用户是否具有共享记录的权限。
    可能的取值:
    true:当前角色的用户可以与其他用户共享记录。
    false:当前角色的用户不能与其他用户共享记录。

  • forecast_manager字符串, 可选

    表示预测经理的唯一ID。仅当预测管理基于角色层级时适用。

示例输入

Copied{
  "roles": [
    {
      "id": "4150868000000231921",
      "name": "Sales department Head",
             "reporting_to": {
                "name": "CEO",
                "id": "5843104000000026005"
         },
      "forecast_manager": "738964000000291009",
      "description": "Manage the sales department",
      "share_with_peers": true
    }
  ]
}

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

    HTTP请求方法类型无效
    解决方法:您为访问API的URL指定了无效的HTTP方法。请指定有效的请求方法。请参阅本页开头上方的端点部分。

  • AUTHORIZATION_FAILEDHTTP 400

    用户没有足够的权限来更新角色
    解决方法:该用户没有更新权限。请联系系统管理员。

  • INVALID_DATAHTTP 400

    提供的ID似乎无效
    解决方法:在reporting_to键中指定的角色ID无效。请指定有效的角色ID。

  • INVALID_DATAHTTP 400

    数据无效
    解决方法:每次 API 调用只能更新一个角色。

  • INVALID_DATAHTTP 400

    所提供的角色ID无效
    解决方法:请求输入中指定的角色ID无效或已被删除。请指定有效的角色ID。

  • DUPLICATE_DATAHTTP 400

    添加角色失败,因为已存在同名角色
    解决方法: 在请求输入中指定一个唯一的角色名称。

  • MANDATORY_NOT_FOUNDHTTP 400

    未找到必填字段
    解决方法:在请求输入中指定要更新的角色的唯一 ID。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您用于调用此 API 的访问令牌不具有所需的权限范围。
    解决方法:生成一个具有该 API 所需权限范围的新访问令牌。请参阅本页面开头的权限范围部分,获取所需权限范围的列表。

  • NO_PERMISSIONHTTP 403

    无权限更新
    解决方法:用户没有更新角色数据的权限。请联系您的系统管理员。

  • INVALID_URL_PATTERN HTTP 404

    请求的URL不正确。
    解决方法:请指定有效的请求URL。详情请参考本页开头的请求URL部分。

  • INTERNAL_ERRORHTTP 500

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

示例响应

Copied{
    "code": "SUCCESS",
    "details": {
        "id": "4150868000000231921"
    },
    "message": "Role updated",
    "status": "success"
}