转移记录并删除用户
目的
要从CRM中删除用户并将记录转移到新用户,可以在以下位置替换该用户:
- 所有权:您可以将旧用户的所有未结记录转移给新用户。
- 分配:您可以在分配规则、升级规则、字段更新、自动化操作等位置用新用户替换旧用户。
- 配置/条件:您可以在自定义视图、自动化、报告等条件中,将原用户替换为新用户。
当您通过此 API 删除用户时,调度器会调度一个作业,并在响应中返回作业 ID。请使用 状态 API 来检查该作业的状态。
端点
- POST /users/actions/transfer_and_delete
- POST /users/actions/transfer_and_delete
请求详情
请求 URL
{api-domain}/crm/{version}/users/actions/transfer_and_delete
要删除特定用户:
{api-domain}/crm/{version}/users/{user_id}/actions/transfer_and_delete
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.users.ALL
(或)
scope=ZohoCRM.users.DELETE
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/users/actions/transfer_and_delete"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST输入 JSON
- id 字符串,如果请求 URL 中未提供则为必填项
您想要删除的用户的唯一 ID,并将其未完成的记录转移给其他用户。请使用 获取用户 API 来获取该用户的 ID。
- transfer JSON 对象,必填
您希望将旧用户记录转移到的新用户的详细信息。
- id,字符串,必填 - 您希望将旧用户的记录转移到该用户的记录 ID。请使用 获取用户 API 获取用户 ID。
- records,布尔值,必填 - true 表示您希望将未完成的记录转移给新用户。
- assignment,布尔值,必填 - true 表示您希望在分配规则、升级规则、字段更新、自动化操作等位置替换用户。
- criteria,布尔值,必填 - true 表示您希望在自定义视图、自动化、报表等使用旧用户作为条件的位置替换为新用户。
- move_subordinate JSON 对象,如果未提供 "transfer" 字段,则为必填项
您希望将旧用户的下属转移至的新用户的详细信息。
- id,字符串,必填 - 您希望将旧用户的下属转移至的用户记录 ID。可使用 获取用户 API 获取该用户的 ID。
示例输入
Copied{
"transfer_and_delete": [
{
"id": "3652397000001464001",
"transfer": {
"id": "3652397000000186017",
"records": true,
"assignment": true,
"criteria": true
},
"move_subordinate": {
"id": "3652397000000186017"
}
}
]
}可能的错误
- MANDATORY_NOT_FOUNDHTTP 400
您未包含要删除用户的 ID。
解决方法:您必须在请求 URL 或输入正文中包含要删除的用户 ID。请使用 获取用户 API 来获取用户的 ID。 - EXPECTED_FIELD_MISSINGHTTP 400
您在输入中既未指定“transfer”,也未指定“move_subordinate”。
解决方法:请在输入中指定“transfer”或“move_subordinate”中的任意一个。 - INVALID_DATAHTTP 400
您在 URL 或正文中指定了错误的用户 ID。
解决方法: 请指定正确的用户 ID。 - INVALID_DATAHTTP 400
您尝试删除的用户,或您想要转移记录的用户,并不是CRM用户。
解决方案:您只能删除CRM用户,并且只能将记录转移给CRM用户。请使用 获取用户 API 来获取您组织中的用户列表。请参考响应中的 "details" 键。 - INVALID_DATAHTTP 400
您尝试删除的用户或您想要转移记录的用户已被删除。
解决方法:您不能删除或将记录转移给已被删除的用户。 - INVALID_DATAHTTP 400
您要转移记录的用户ID无效。
解决方法:请提供有效的用户ID。 - INVALID_DATAHTTP 400
您尝试转移下属的用户处于非激活状态。
解决方法:您只能将下属转移给激活状态的用户。 - INVALID_DATAHTTP 400
您已在 URL 中指定了用户 ID,但请求体中包含了多个 JSON 对象。
解决方法: 如果您在 URL 中指定了用户 ID,则只能删除该用户,请求体中也只能包含该用户的详细信息。 - INVALID_DATAHTTP 400
您正在尝试通过此 API 删除多个用户。
解决方法:您只能使用此 API 删除一个用户,并将其记录转移给其他用户。 - NOT_ALLOWEDHTTP 400
您尝试转移下属的用户本身是一个下属用户。
解决办法:您不能将下属转移给其他下属用户。 - NOT_ALLOWEDHTTP 400
您尝试删除的用户是该组织的超级管理员。
解决方法:您无法删除该组织的超级管理员。 - NO_PERMISSIONHTTP 403
您不是组织的超级管理员,无法访问此 API。
解决方法:只有组织的超级管理员才能删除用户并转移记录。
示例响应
Copied{
"transfer_and_delete": [
{
"code": "SUCCESS",
"details": {
"jobId": "3652397000012622009",
"id": "3652397000001464001"
},
"message": "user is deleted successfully",
"status": "success"
}
]
}