Zoho crm Logo

更新用户

目的

更新您组织内用户的详细信息。

终端点

  • PUT /users
  • PUT /users/{user_id}

请求详情

请求 URL

{api-domain}/crm/{version}/users

更新指定用户
{api-domain}/crm/{version}/users/{user_id}

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.users.{operation_type}

可能的操作类型

全部 - 用户完全访问权限
Update - Update用户数据

注意

每次 PUT 请求只能更新一个用户的详细信息。

样本请求

Copiedcurl "https://www.zohoapis.com/crm/v8/users"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@updateuser.json"
-X PUT
Copieduser1 = Map();
user1.put("id", "692969000000282009");
user1.put("last_name", "B");

users_list = List();
users_list.add(user1);

params = Map();
params.put("users", users_list);

response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/users"
	type: PUT
	parameters: params.toString()
	connection:"crm_connection"
];
info response ;

在请求中,"@updateuser.json" 包含示例输入数据。

请求 JSON
  • id字符串,必填

    请指定您要更新的用户记录ID。

注意

  • 您也可以在请求中传递记录ID。例如:{api-domain}/crm/v7/Users/{record_id}
  • 请参考获取UsersAPI以获取用户的记录ID。
  • 您无法更新已被停用的用户。
  • 您无法停用组织的主联系人。如需停用主联系人,您必须先将其他用户指定为新主联系人,然后再停用原主联系人。
  • 要激活或停用用户,请在输入中使用status键,并将其值分别设置为active或inactive。
  • 您无法更改其他用户的时区。您只能更改自己的用户记录的时区。有关“time_zone”键的值,请参考字段元数据API。
  • 输入时只能使用字段API名称。字段API名称可通过字段元数据API获取(每个字段“api_name”键的值)。
  • 关于字段类型及其限制,请参考Insert记录API。

示例输入

Copied{
  "users": [
    {
      "id": "554023000000691003",
      "phone": "123456789",
      "dob": "1990-12-31",
      "role":"79234000000031154",
      "profile":"79234000000031157",
      "country_locale": "en_US",
      "time_format": "HH:mm",
      "time_zone": "US/Samoa",
      "name_format__s": "Salutation,First Name,Last Name",
      "sort_order_preference__s": "First Name,Last Name"
    }
  ]
}

可能的错误

  • INVALID_DATAHTTP 415
    • 您正在尝试更新其他用户的时区

      。

    • 在签名中发现未闭合的 Script 标签。
    • “sort_order_preference__s”或“name_format__s”的输入不正确。

    解决方法:

    • 您不能更新其他用户的时区。
    • 请指定有效的 script 标签。
    • 请参考响应中的 "details" 键,查找具体错误并进行修正。
  • 无法更新_DeleteD_USERHTTP 400

    无法更新已Delete的USer
    解决方法:你不能更新已Delete的USer。

  • INVALID_REQUESTHTTP 400

    已确认的用户不允许重新邀请
    解决方法:您无法重新邀请已确认的用户。

  • NOT_ALLOWEDHTTP 400

    您正在尝试更新其他用户的姓名格式和排序方式偏好。
    解决方法:您只能更新自己的姓名格式和排序方式偏好。

  • EMAIL_UPDATE_NOT_ALLOWEDHTTP 400

    无法更新已确认CRM用户的邮箱
    解决方法:您不能更新已确认用户的邮箱。

  • DUPLICATE_DATAHTTP 400

    具有相同邮箱ID的用户已存在于CRM Plus
    解决方法:您正在为唯一字段指定重复值。请确保为所有用户指定唯一且有效的邮箱ID。

  • ID_ALREADY_DEACTIVATEDHTTP 400

    用户已被停用
    解决方法:您尝试停用的用户已经被停用。

  • INVALID_REQUESTHTTP 400

    Primary Contact无法被停用
    解决方法:您不能停用Primary Contact。

  • ID_ALREADY_ACTIVEHTTP 400

    用户已处于激活状态
    解决方法:您尝试激活的用户已经是激活状态。

  • FEATURE_PERMISSIONHTTP 400

    下属之间共享功能不可用
    解决方法:您的账户无法使用下属之间共享功能。请联系系统管理员。

  • INVALID_REQUEST_METHODHTTP 400

    HTTP请求方法类型无效
    解决方法: 您为访问API URL 指定了无效的HTTP方法。请指定有效的请求方法。请参考上方的接口端点部分。

  • MANDATORY_NOT_FOUNDHTTP 400

    未找到必填字段
    解决方法: 您在请求中未指定要更新用户的唯一ID。请指定该用户的唯一ID。

  • AUTHORIZATION_FAILEDHTTP 403
    • 试用已过期,或者用户没有足够的权限执行此操作
    • 当前用户没有权限更新其他用户的个人资料和角色。

    解决方法:请联系您的系统管理员。

  • INTERNAL_ERRORHTTP 400

    在更新CRM Plus 用户至CRM Account时发生错误
    解决方法:您不能从您的CRM Account中更新CRM Plus 用户。

  • INVALID_URL_PATTERN HTTP 404

    请检查尝试访问的URL是否正确
    解决方法:请求的URL不正确。请提供有效的请求URL。请参考上方的请求URL部分。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未授权
    解决方法:客户端没有 ZohoCRM.users.UPDATE 的权限范围。请创建一个具有有效权限范围的新客户端。请参阅上面的权限范围部分。

示例回复

Copied{
  "users": [
    {
      "code": "SUCCESS",
      "details": {
        "id": "554023000000691003"
      },
      "message": "User updated",
      "status": "success"
    }
  ]
}