/api/v1/profile/delete/ プロファイルを削除する
プロファイルの個人データを消去し、スケジュールされたメールをキャンセルします。削除権（忘れられる権利）のリクエストを履行するために使用します。
external_profile_id、customer_user_id、または email でプロファイルを特定します — 少なくとも1つを送信してください。Adapty Mail はメールアドレスでユーザーを照合するため、送信した email のみが識別子として使用されます。email を省略した場合は、external_profile_id または customer_user_id でプロファイルが検索されます。
削除によって保存済みデータはクリアされますが、そのアドレスがブロックされるわけではありません。その後の プロファイルを保存する リクエストによって新しいプロファイルが作成されますが、削除されたプロファイルの履歴は引き継がれません。誰かを永続的に除外したい場合は、そのデータの送信を停止してください。
external_profile_id または customer_user_id による削除を繰り返しても、何も変更せずに成功します。email のみで行った削除を繰り返した場合は 404 が返されます。消去によって保存済みアドレスがクリアされるため、メールアドレスで照合できるものが残っていないためです。
Request body
削除するプロファイルの識別子。external_profile_id、customer_user_id、email のいずれか少なくとも1つを送信してください。
プロファイルを保存する際に送信した識別子。
お客様自身のシステムにおけるユーザーの識別子。
プロファイルに登録されているメールアドレス。
Responses
プロファイルが削除されました。レスポンスにボディはありません。
識別子が指定されていません。
Schema
標準エラーレスポンス。すべての失敗は、この形式で 4XX ステータスを返します。
エラーの人間が読める説明。
機械可読なエラー識別子。
このエラーの HTTP ステータスコード。
エラーの原因となったリクエストフィールド。エラーがフィールド固有でない場合は null。
Example
{
"errors": [
{
"message": "At least one of external_profile_id, customer_user_id or email must be provided",
"error_code": "missing_identifier",
"status_code": 400,
"field_name": null
}
]
}シークレット API キーが存在しないか無効です。
Schema
標準エラーレスポンス。すべての失敗は、この形式で 4XX ステータスを返します。
エラーの人間が読める説明。
機械可読なエラー識別子。
このエラーの HTTP ステータスコード。
エラーの原因となったリクエストフィールド。エラーがフィールド固有でない場合は null。
Example
{
"errors": [
{
"message": "Secret key doesn't exist",
"error_code": "secret_key_does_not_exist_error",
"status_code": 403,
"field_name": null
}
]
}送信した識別子に一致するプロファイルが見つかりません。
Schema
標準エラーレスポンス。すべての失敗は、この形式で 4XX ステータスを返します。
エラーの人間が読める説明。
機械可読なエラー識別子。
このエラーの HTTP ステータスコード。
エラーの原因となったリクエストフィールド。エラーがフィールド固有でない場合は null。
Example
{
"errors": [
{
"message": "Profile not found",
"error_code": "profile_not_found_error",
"status_code": 404,
"field_name": null
}
]
}