ユーザー削除API

最新更新：2025-07-22

前提条件

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

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

削除前の推奨事項

タグとエイリアス情報の照会：タグエイリアスAPIを使用して、削除対象のregistration_idに現在バインドされているエイリアスとタグを照会します。
対象ユーザーの確認：削除する対象ユーザーを慎重に確認します。

❗️警告：すべてのユーザーを削除しないでください。これらの手順を実行するときは非常に慎重に行い、すべてのユーザーが削除されないようにしてください。

ユーザー削除APIの説明

このAPIは既存のユーザー（registration_id）を削除するために使用されます。関連するすべてのデータ、バインドされているタグ、エイリアス、デバイス情報、タイムゾーン情報が削除されます。この削除は非同期で実行されます。

エンドポイント

DELETE /v4/devices/{registration_id}

              
              DELETE /v4/devices/{registration_id}

このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

DELETE /v4/devices/{registration_id} Authorization: Basic (base64認証文字列) Accept: application/json

              
              DELETE /v4/devices/{registration_id}
Authorization: Basic (base64認証文字列)
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"
    }
}

このコードブロックはフローティングウィンドウ内に表示されます

お問い合わせ