/api/v1/profile/delete/ Удалить профиль
Удаляет персональные данные профиля и отменяет его запланированные письма. Используйте это для выполнения запроса на удаление данных (right-to-erasure).
Идентифицируйте профиль по external_profile_id, customer_user_id или email — укажите хотя бы одно значение. Adapty Mail сопоставляет людей по адресу электронной почты, поэтому если вы передаёте email, он является единственным используемым идентификатором; если вы его не передаёте, профиль будет найден по external_profile_id или customer_user_id.
Удаление очищает сохранённые данные, но не блокирует адрес. Последующий запрос Save profile создаст новый профиль без какой-либо истории удалённого. Чтобы навсегда исключить пользователя, прекратите передавать его данные.
Повторное удаление по external_profile_id или customer_user_id завершится успешно без каких-либо изменений. Повторное удаление с указанием только email вернёт 404: удаление очищает сохранённый адрес, поэтому email больше не с чем сопоставить.
Request body
Идентификаторы профиля для удаления. Укажите хотя бы один из параметров: external_profile_id,
customer_user_id или email.
Идентификатор, переданный при сохранении профиля.
Идентификатор пользователя в вашей системе.
Адрес электронной почты, привязанный к профилю.
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
}
]
}