{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/account/password/reset/","auth":"never","examples":{"codes":[{"code":"curl -X POST \\\n-H \"Content-Type: application/json\" \\\n-d '{\"email\":\"<EMAIL_ADDRESS>\"}' \\\n\"https://api.syncano.io/v1.1/account/password/reset/\"","language":"curl","name":""},{"language":"javascript","code":"// Planned for v1.1.0"},{"code":"# Not supported.","language":"python","name":"Python"}]},"method":"post","params":[{"name":"email","type":"string","default":"","desc":"Your email address","required":true,"in":"body","ref":"","_id":"556f8dd49893290d00988de1"}],"results":{"codes":[{"name":"","code":"(empty)","language":"json","status":200},{"name":"","code":"{\n  \"email\": [\n    \"Enter a valid email address.\"\n  ]\n}","language":"json","status":400},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"language":"json","status":404,"code":""}]},"settings":"56c50c06d1b8770d00922288"},"next":{"description":"","pages":[]},"title":"Account - reset password","type":"endpoint","slug":"account-reset-password","excerpt":"Use to send \"reset password\" email to given email address. Doesn't require authentication - no need to pass any API, or Account Key.","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Returns\"\n}\n[/block]\nIf the given email exists in our database, it will return an empty body and send the \"reset password\" email.","updates":[],"order":10,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50634bdcde80d004986d5","user":"548193732dca603300bf6ea1","category":{"sync":{"isSync":false,"url":""},"pages":["56c50634bdcde80d004986cb","56c50634bdcde80d004986cc","56c50634bdcde80d004986cd","56c50634bdcde80d004986ce","56c50634bdcde80d004986cf","56c50634bdcde80d004986d0","56c50634bdcde80d004986d1","56c50634bdcde80d004986d2","56c50634bdcde80d004986d3","56c50634bdcde80d004986d4","56c50634bdcde80d004986d5","56c50634bdcde80d004986d6","56c50634bdcde80d004986d7"],"title":"Account","slug":"account","order":20,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498647","version":"56c50626bdcde80d00498635","__v":1,"createdAt":"2015-03-17T14:10:23.450Z","project":"54774d9af3736008009e9e0e"},"version":{"version":"0.1.1","version_clean":"0.1.1","codename":"API v1.1","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"categories":["56c50628bdcde80d00498636","56c50628bdcde80d00498637","56c50628bdcde80d00498638","56c50628bdcde80d00498639","56c50628bdcde80d0049863a","56c50628bdcde80d0049863b","56c50628bdcde80d0049863c","56c50628bdcde80d0049863d","56c50628bdcde80d0049863e","56c50628bdcde80d0049863f","56c50628bdcde80d00498640","56c50628bdcde80d00498641","56c50628bdcde80d00498642","56c50628bdcde80d00498643","56c50628bdcde80d00498644","56c50628bdcde80d00498645","56c50628bdcde80d00498646","56c50628bdcde80d00498647","56c506a018f0c90d002808de","56c6b0baf795cf0d003ec13e","56fe58eb5a08190e00085149","571764513cf2960e0009a635","571fc008ffbc6a2000b25bb5","5739ca371f4b740e00b06e09","577522f197a3830e004bcc1b","57753d5ffecd260e00d86ce6","57adb71efaa7a10e004495b6"],"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z"},"createdAt":"2015-06-02T20:00:22.353Z","editedParams":true,"githubsync":"","__v":0,"editedParams2":true,"parentDoc":null,"project":"54774d9af3736008009e9e0e"}

postAccount - reset password

Use to send "reset password" email to given email address. Doesn't require authentication - no need to pass any API, or Account Key.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

email:
required
string
Your email address

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Returns" } [/block] If the given email exists in our database, it will return an empty body and send the "reset password" email.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}