{"_id":"579b5f9f8627551900433831","__v":0,"category":{"_id":"579b22d3f4ad7b190094b60e","project":"56e29a8dd3b68d0e00b48ffa","__v":0,"version":"56e29a8dd3b68d0e00b48ffd","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-07-29T09:33:07.078Z","from_sync":false,"order":1,"slug":"accounts","title":"Accounts"},"parentDoc":null,"version":{"_id":"56e29a8dd3b68d0e00b48ffd","hasReference":true,"project":"56e29a8dd3b68d0e00b48ffa","__v":15,"hasDoc":true,"createdAt":"2016-03-11T10:14:37.460Z","releaseDate":"2016-03-11T10:14:37.460Z","categories":["56e29a8ed3b68d0e00b48ffe","56eb917a2e58011700afdfcc","56eb92252109011700f3ba5e","5704d4af849f721900f27835","57052a31473f900e004d5d54","5715222811537f19006aab2d","5715b57b810df00e00cc7832","5715baa9810df00e00cc7837","57180ed83a17770e009a7322","571810273a17770e009a7325","579b22d3f4ad7b190094b60e","584538ecba4f1c0f0096925e","586bb88e5602870f00ae7177","5a70407fb0a01400369583c5","5ace359e40606a0003eac1de"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"githubsync":"","user":"5795d43eb9ee2d0e00df357a","project":"56e29a8dd3b68d0e00b48ffa","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-29T13:52:31.851Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[{"name":"","code":"{ \n  'Message' : 'An email has been sent to test:::at:::example.com with instructions on how to reset your password.' \n}","language":"json","status":200},{"name":"","code":"{ 'Message' : 'Invalid email address' }","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"579b5f9f8627551900433832","ref":"","in":"query","required":true,"desc":"","default":"","type":"string","name":"email"}],"url":"/account/reset"},"isReference":true,"order":4,"body":"In the event that you've lost or forgotten your password, calling the Reset Password endpoint will send an email to the submitted address containing instructions on how to reset it. \n\nThe email will include a link that, when followed, will allow the user to enter a new password, overriding the old one. \n\nIt is important to note that the security of API account ultimately rests with that of the email account - anyone with access to the email account will potentially have access to all your account functionality.","excerpt":"Start the password resetting process in the event of a lost or forgotten password.","slug":"reset-password","type":"endpoint","title":"Reset Password"}

postReset Password

Start the password resetting process in the event of a lost or forgotten password.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

email:
required
string

Result Format


Documentation

In the event that you've lost or forgotten your password, calling the Reset Password endpoint will send an email to the submitted address containing instructions on how to reset it. The email will include a link that, when followed, will allow the user to enter a new password, overriding the old one. It is important to note that the security of API account ultimately rests with that of the email account - anyone with access to the email account will potentially have access to all your account functionality.