diff --git a/website/server/controllers/top-level/email.js b/website/server/controllers/top-level/email.js index ec77d5b10b..f5dde08d90 100644 --- a/website/server/controllers/top-level/email.js +++ b/website/server/controllers/top-level/email.js @@ -12,12 +12,13 @@ let api = {}; * @apiDescription Does not require authentication * @apiName UnsubscribeEmail * @apiGroup Unsubscribe - * @apiDescription This is a GET method so that you can put the unsubscribe link in emails. + * @apiDescription This is a GET method included in official emails from Habitica that will unsubscribe the user from emails. * - * @apiParam {String} code Query parameter - An unsubscription code + * @apiParam (Query) {String} code An unsubscription code * - * @apiSuccess {String} An html success message + * @apiSuccess {String} Webpage An html success message * + * @apiError (400) {BadRequest} missingUnsubscriptionCode The unsubscription code is missing. * @apiUse UserNotFound */ api.unsubscribe = {