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

删除用户画像

Copy as Markdown

清除用户画像的个人数据并取消其计划发送的邮件。可用于履行数据删除权请求。

通过 external_profile_id、customer_user_id 和 email 的任意组合来标识用户画像——Adapty Mail 的解析方式与保存时相同。

删除操作不可撤销。之后使用相同标识符发起的 保存用户画像 请求不会重新创建该用户画像。

通过 external_profile_id 或 customer_user_id 重复删除操作时，请求会再次成功但不会产生任何变化。若仅通过 email 重复删除，则会返回 404：因为删除操作会清除已存储的邮件地址，导致无法再通过邮件进行匹配。

Request body

要删除的用户画像标识符。请至少提供 external_profile_id、 customer_user_id 或 email 之一。

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