POST /api/v1/profile/delete/

プロファイルを削除する

プロファイルの個人データを消去し、スケジュールされたメールをキャンセルします。削除権(忘れられる権利)のリクエストを処理するために使用します。

external_profile_idcustomer_user_idemail のいずれかの組み合わせでプロファイルを識別します — Adapty Mail は保存時と同じ方法でプロファイルを解決します。

消去は最終的なものです。同じ識別子を持つ後続の プロファイルを保存する リクエストはプロファイルを再作成しません。

external_profile_id または customer_user_id による削除を繰り返すと、何も変更せずに再度成功します。email のみを含む削除を繰り返すと 404 が返されます:消去により保存されたアドレスがクリアされるため、メールアドレスには一致するものが残りません。

Request body

削除するプロファイルの識別子。external_profile_idcustomer_user_idemail のいずれか少なくとも1つを送信してください。

external_profile_idstring

プロファイルを保存する際に送信した識別子。

customer_user_idstring

お客様自身のシステムにおけるユーザーの識別子。

emailstring

プロファイルに登録されているメールアドレス。

Responses

プロファイルが削除されました。レスポンスのボディはありません。

識別子が提供されませんでした。

Schema

標準エラーレスポンス。すべての失敗は、この形式で 4XX ステータスを返します。

errorsarray of object
messagestring

エラーの人間が読める説明。

error_codestring

機械可読なエラー識別子。

status_codeinteger

このエラーの HTTP ステータスコード。

field_namestring

エラーの原因となったリクエストフィールド。エラーがフィールド固有でない場合は 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 ステータスを返します。

errorsarray of object
messagestring

エラーの人間が読める説明。

error_codestring

機械可読なエラー識別子。

status_codeinteger

このエラーの HTTP ステータスコード。

field_namestring

エラーの原因となったリクエストフィールド。エラーがフィールド固有でない場合は 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 ステータスを返します。

errorsarray of object
messagestring

エラーの人間が読める説明。

error_codestring

機械可読なエラー識別子。

status_codeinteger

このエラーの HTTP ステータスコード。

field_namestring

エラーの原因となったリクエストフィールド。エラーがフィールド固有でない場合は null

Example
{
  "errors": [
    {
      "message": "Profile not found",
      "error_code": "profile_not_found_error",
      "status_code": 404,
      "field_name": null
    }
  ]
}