Удаление email-адресов пользователя

Удаление email-адресов пользователя
Beta
New

⚠️
Ограниченный доступ

Описание

Этот раздел документации описывает конечную точку для удаления одного или нескольких email-адресов из аккаунта аутентифицированного пользователя. Удаление возможно только для непривязанных к активным сессиям и неосновных адресов.

Общие замечания

  1. Для версий API указывайте заголовок Accept с соответствующей версией:

    Accept: application/vnd.gitverse+json;version=1
  2. Базовый URL для всех конечных точек:

    https://api.gitverse.ru
  3. Все данные возвращаются в формате JSON.

  4. Если запрос завершается неудачно, API возвращает объект ошибки с кодом состояния HTTP и сообщением.

Скоупы

Для успешного выполнения этого запроса требуется один из следующих скоупов:

  • "write:public_api";
  • "public_api".

Конечная точка

DELETE /user/emails

Параметры пути

Нет обязательных параметров пути. Конечная точка /user/emails автоматически определяет текущего аутентифицированного пользователя на основе предоставленного токена.

Заголовки запроса

  • Content-Type: application/json — указывает, что тело запроса имеет формат JSON;
  • Accept: application/vnd.gitverse+json;version=1 — указывает версию API;
  • Authorization: Bearer {user_token} — требуется для аутентификации.

Тело запроса

Тело запроса должно содержать массив email-адресов, которые необходимо удалить:

ПолеТипОписание
emailsarray of stringsМассив email-адресов, подлежащих удалению.

Пример запроса

DELETE https://api.gitverse.ru/user/emails
Content-Type: application/json
Accept: application/vnd.gitverse+json;version=1
Authorization: Bearer YOUR_ACCESS_TOKEN
 
{
  "emails": ["new4@example.com", "new5@example.com", "new6@example.com"]
}

Пример ответа (успешное удаление)

{
  "message": "Emails successfully deleted",
  "deleted_emails": ["new4@example.com", "new5@example.com", "new6@example.com"],
  "status": 200
}

Поля ответа

ПолеТипОписание
messagestringКраткое описание результата операции.
deleted_emailsarray of stringsСписок успешно удалённых email-адресов.
statusintegerКод статуса HTTP.

Обработка ошибок

Если запрос завершается неудачно, API возвращает объект ошибки с кодом состояния HTTP и сообщением:

Пример ошибки

{
  "error": "Forbidden",
  "message": "Cannot delete primary email address.",
  "status": 403
}

Возможные коды ошибок

  • 400 Bad Request — некорректный запрос или невалидные email-адреса;
  • 401 Unauthorized — необходима аутентификация. Отсутствует или неверен токен;
  • 403 Forbidden — запрещено удалять основной email или email используется в активной сессии;
  • 500 Internal Server Error — внутренняя ошибка сервера.

Следующие шаги

После удаления email-адресов вы можете:

  • получить обновлённый список адресов с помощью метода GET /user/emails;
  • добавить новые адреса через метод POST /user/emails.

Если у вас возникнут вопросы или потребуется дополнительная информация, пожалуйста, обращайтесь в службу поддержки или свяжитесь с командой разработки.