POST /api/v1/profile/delete/

Удалить профиль

Удаляет персональные данные профиля и отменяет его запланированные письма. Используйте этот метод для выполнения запроса на удаление данных в соответствии с правом на забвение.

Идентифицируйте профиль с помощью любой комбинации external_profile_id, customer_user_id и email — Adapty Mail разрешает профиль так же, как и при сохранении.

Удаление является необратимым. Последующий запрос Save profile с теми же идентификаторами не пересоздаёт профиль.

Повторное удаление по external_profile_id или customer_user_id завершится успешно, не изменив ничего. Повторное удаление только по email вернёт 404: удаление очищает сохранённый адрес, поэтому email не соответствует ни одной записи.

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