diff options
Diffstat (limited to 'doc/api/users.md')
| -rw-r--r-- | doc/api/users.md | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/api/users.md b/doc/api/users.md index cd911196f74..2908f552a9d 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -1695,12 +1695,13 @@ Parameters: ## Delete email for current user -Deletes email owned by authenticated user. +Deletes the specified email address owned by the authenticated user. Cannot be used to delete a primary email address. -This returns a `204 No Content` status code if the operation was successfully -or `404` if the resource was not found. +If the deleted email address is used for any user emails, those user emails are sent to the primary email address instead. -This cannot delete a primary email address. +NOTE: +Because of [known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/438600), group notifications are still sent to +the deleted email address. ```plaintext DELETE /user/emails/:email_id @@ -1712,6 +1713,11 @@ Parameters: |------------|---------|----------|-------------| | `email_id` | integer | yes | Email ID | +Returns: + +- `204 No Content` if the operation was successful. +- `404` if the resource was not found. + ## Delete email for given user **(FREE SELF)** Prerequisites: |