Accounts

Email a password reset link (always 202)

POST
/auth/password/forgot

Email a password reset link (always 202).

Header Parameters

X-Requested-With*string

CSRF guard: must be quartermaster on every mutation.

Request Body

application/json

Request a password reset email.

Request a password reset email.

email*string

Email address.

Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
Lengthlength <= 254

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/auth/password/forgot" \  -H "X-Requested-With: quartermaster" \  -H "Content-Type: application/json" \  -d '{    "email": "ada@example.com"  }'
{  "status": "sent"}