Auth

Request a password reset

POST
/api/v1/auth/forgot-password

Always returns success so the response cannot be used to discover which email addresses are registered. With no mail server configured, the token is returned directly instead of being emailed.

Request Body

application/json

email*string
Formatemail

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/auth/forgot-password" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'
{  "data": {    "message": "Done.",    "ok": true,    "resource_id": "string"  },  "meta": {},  "success": true}