{"_id":"5450c8c67abbbc0800a5e9c0","category":{"_id":"5450c103a66f020800dba819","__v":5,"pages":["5450c240a66f020800dba827","5450c5c87abbbc0800a5e9a6","5450c792a66f020800dba83e","5450c8c67abbbc0800a5e9c0","5450cec17abbbc0800a5e9df"],"project":"543d1e263a300f20000d31fb","version":"543d1e5e5276641a00a593cf","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-29T10:27:15.385Z","from_sync":false,"order":9,"slug":"user","title":"User"},"version":{"_id":"543d1e5e5276641a00a593cf","forked_from":"543d1e263a300f20000d31fe","project":"543d1e263a300f20000d31fb","__v":16,"createdAt":"2014-10-14T13:00:14.946Z","releaseDate":"2014-10-14T13:00:14.946Z","categories":["543d1e5f5276641a00a593d0","543d1ee45276641a00a593da","5448e2cbc64edd1a00453c29","5449135acdc944220048845c","544a0a93778b3e08002b2289","544a0a9727b7fc140078da58","544a456f27b7fc140078daff","544e027cbd51b9080037f680","544e029ab80812080035bba6","544e3a2eb80812080035bd67","5450b7c5a66f020800dba7b3","5450c0e47abbbc0800a5e989","5450c0f97abbbc0800a5e98a","5450c103a66f020800dba819","54f99f588d09b7390007ea45","565c81dbf3e9360d00823e43"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"parentDoc":null,"editedParams2":true,"project":"543d1e263a300f20000d31fb","__v":0,"editedParams":true,"is_link":false,"user":"54352decadf50e0800b89024","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-29T11:00:22.040Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"try":true,"basic_auth":false,"method":"post","results":{"codes":[{"status":400,"name":"","code":"{\n\t/* Standard error response */\n}","language":"json"},{"language":"json","status":404,"code":"{\n\t/* account not found */\n}"}]},"auth":"never","params":[{"_id":"5450c8c67abbbc0800a5e9c5","ref":"","in":"body","required":true,"desc":"Your API session token.","default":"","type":"string","name":"_token"},{"_id":"5450c8c67abbbc0800a5e9c4","ref":"","in":"body","required":false,"desc":"Your API session signature.","default":"","type":"string","name":"_signature"},{"_id":"5450c8c67abbbc0800a5e9c3","ref":"","in":"body","required":true,"desc":"Email of user account to reset.","default":"","type":"string","name":"email"},{"_id":"5450c8c67abbbc0800a5e9c2","ref":"","in":"body","required":true,"desc":"URL of redirect if password reset is successful.","default":"","type":"string","name":"success_redirect"},{"_id":"5450c8c67abbbc0800a5e9c1","ref":"","in":"body","required":true,"desc":"URL of redirect if password reset failed.","default":"","type":"string","name":"error_redirect"}],"url":"/v2/users/reset"},"isReference":false,"order":3,"body":"Reset an account's password.\n\nA reset link will be mailed to the account holder.","excerpt":"","slug":"user-reset-password","type":"endpoint","title":"User Reset Password"}

postUser Reset Password


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

_token:
required
string
Your API session token.
_signature:
string
Your API session signature.
email:
required
string
Email of user account to reset.
success_redirect:
required
string
URL of redirect if password reset is successful.
error_redirect:
required
string
URL of redirect if password reset failed.

Result Format


Documentation

Reset an account's password. A reset link will be mailed to the account holder.