krikkert/habitica
1
0
Fork 0
mirror of https://github.com/HabitRPG/habitica.git synced 2025-12-17 22:57:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Unsubscribe documentation

Browse Source 
closes #8187
This commit is contained in:
MathWhiz
2016-11-04 09:38:50 -04:00
committed by Blade Barringer
parent 5108480ec5
commit f8fe16482d
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
website/server/controllers/top-level/email.js
View File

@@ -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 = {