English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
POST /api/v1/profile/delete/

Xóa hồ sơ người dùng

Copy as Markdown

Xóa dữ liệu cá nhân của hồ sơ người dùng và hủy các email đã được lên lịch. Sử dụng tính năng này để thực hiện yêu cầu quyền xóa dữ liệu.

Xác định hồ sơ người dùng bằng external_profile_id, customer_user_id hoặc email — gửi ít nhất một trong số đó. Adapty Mail khớp người dùng theo địa chỉ email, vì vậy email bạn gửi là định danh duy nhất được thử; nếu bỏ qua email, external_profile_id hoặc customer_user_id sẽ được dùng để tìm hồ sơ người dùng thay thế.

Xóa dữ liệu sẽ xóa sạch dữ liệu đã lưu, nhưng không chặn địa chỉ đó. Một yêu cầu Save profile sau đó sẽ tạo một hồ sơ người dùng mới, không có lịch sử nào của hồ sơ người dùng đã bị xóa. Để ngăn ai đó vĩnh viễn, hãy ngừng gửi dữ liệu của họ.

Lặp lại thao tác xóa bằng external_profile_id hoặc customer_user_id sẽ thành công mà không thay đổi bất cứ điều gì. Lặp lại thao tác xóa chỉ dùng email sẽ trả về 404: vì quá trình xóa đã xóa địa chỉ đã lưu, nên email không còn gì để khớp nữa.

Request body

Định danh cho hồ sơ người dùng cần xóa. Gửi ít nhất một trong các trường external_profile_id, customer_user_id, hoặc email.

external_profile_idstring

Định danh bạn đã gửi khi lưu hồ sơ người dùng.

customer_user_idstring

Định danh của người dùng trong hệ thống của bạn.

emailstring

Địa chỉ email trên hồ sơ người dùng.

Responses

Hồ sơ người dùng đã được xóa. Phản hồi không có nội dung.

Không có định danh nào được cung cấp.

Schema

Phản hồi lỗi tiêu chuẩn. Mọi lỗi đều trả về trạng thái 4XX với cấu trúc này.

errorsarray of object
messagestring

Mô tả lỗi có thể đọc được.

error_codestring

Mã định danh lỗi dành cho máy đọc.

status_codeinteger

Mã trạng thái HTTP cho lỗi này.

field_namestring

Trường yêu cầu gây ra lỗi, hoặc null nếu lỗi không liên quan đến trường cụ thể nào.

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
    }
  ]
}

Thiếu hoặc API key bí mật không hợp lệ.

Schema

Phản hồi lỗi tiêu chuẩn. Mọi lỗi đều trả về trạng thái 4XX với cấu trúc này.

errorsarray of object
messagestring

Mô tả lỗi có thể đọc được.

error_codestring

Mã định danh lỗi dành cho máy đọc.

status_codeinteger

Mã trạng thái HTTP cho lỗi này.

field_namestring

Trường yêu cầu gây ra lỗi, hoặc null nếu lỗi không liên quan đến trường cụ thể nào.

Example 
{
  "errors": [
    {
      "message": "Secret key doesn't exist",
      "error_code": "secret_key_does_not_exist_error",
      "status_code": 403,
      "field_name": null
    }
  ]
}

Không tìm thấy hồ sơ người dùng nào khớp với các định danh bạn đã gửi.

Schema

Phản hồi lỗi tiêu chuẩn. Mọi lỗi đều trả về trạng thái 4XX với cấu trúc này.

errorsarray of object
messagestring

Mô tả lỗi có thể đọc được.

error_codestring

Mã định danh lỗi dành cho máy đọc.

status_codeinteger

Mã trạng thái HTTP cho lỗi này.

field_namestring

Trường yêu cầu gây ra lỗi, hoặc null nếu lỗi không liên quan đến trường cụ thể nào.

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