Delete User API

前提条件

ユーザーを削除すると、復元することはできません。削除されたユーザーが再度メッセージを受信できるのは、以下のシナリオのみです:

  • Web:ブラウザのクッキーをクリアした後、ウェブサイトに戻ります。
  • モバイル:アプリを再度開くか、アンインストールして再インストールしてSDKを再初期化します。アプリ内のSDKを最新バージョンに更新することを推奨します。

削除前の推奨事項

  1. タグとエイリアス情報の照会:タグエイリアスAPIを使用して、削除対象のregistration_idに現在バインドされているエイリアスとタグを照会します。

  2. 対象ユーザーの確認:削除対象の対象ユーザーを慎重に確認します。

    ❗️警告:すべてのユーザーを削除しないでください。これらの手順を実行する際は非常に注意が必要で、すべてのユーザーが削除されないように確認してください。

Delete User API 説明

この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"
    }
}

            
このコードブロックはフローティングウィンドウ内に表示されます
icon
お問い合わせ