删除用户API

最新更新:2024-07-10

前提

一旦删除用户,就无法将其恢复。已删除的用户只能在以下情况下再次收到消息:

  • Web:清除浏览器 cookie,然后返回您的网站。
  • 移动设备:再次打开应用程序或者卸载重装App以重新进行SDK初始化。建议您在应用程序中更新最新版本的SDK。。

删除前的建议

  1. 查询标签和别名信息:通过标签别名API,查询要删除的registration_id目前绑定的别名和标签信息。

  2. 检查受众群体:仔细检查要删除的受众群体。

    ❗️警告:请勿删除所有用户。执行这些步骤时要非常小心,确保不要删除所有用户。

删除用户API说明

该接口用于删除现有用户(registration_id),这将删除其所有相关数据和绑定标签别名,以及设备信息和时区信息。此删除操作是异步执行的。

调用地址

DELETE /v4/devices/{registration_id}
          DELETE /v4/devices/{registration_id}

        
此代码块在浮窗中显示

请求报头

DELETE /v4/devices/{registration_id} Authorization: Basic (base64 auth string) Accept: application/json
          DELETE /v4/devices/{registration_id}
Authorization: Basic (base64 auth string)
Accept: application/json

        
此代码块在浮窗中显示

请求参数

名称 是否必选 说明
Registration ID 设备在engagelab系统的唯一标识,不支持批量删除

请求示例

DELETE /v4/devices/abc123 Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l Accept: application/json
          DELETE /v4/devices/abc123
Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
Accept: application/json

        
此代码块在浮窗中显示

返回示例

成功返回

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "success": true }
          HTTP/1.1 200 OK 
Content-Type: application/json; charset=utf-8
{
  "success": true
}

        
此代码块在浮窗中显示

失败返回

{ "error":{ "code":27002, "message":"unknown error" } }
          {
  "error":{
    "code":27002, 
    "message":"unknown error"
    }
}

        
此代码块在浮窗中显示
在文档中心打开
Contact Sales