Email a password reset code

POST /v1/auth/password/forgot

The response is the same whether or not the address has an account.

Body

application/json

emailstringrequired

maxLength: 254

Responses

errors: application/problem+json

202

Accepted

422

Unprocessable Entity

429

Too Many Requests

500

Internal Server Error

Match errors on the problem's code, which stays the same, not on its message.

Send a request

Server

Body

The request goes from your browser straight to this server; nothing passes through this site. The API must allow this site's origin for CORS.

Requestexample

curl -X POST "$API_URL/v1/auth/password/forgot" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "ada@example.com"
}'

body := strings.NewReader(`{
  "email": "ada@example.com"
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost,
	apiURL + "/v1/auth/password/forgot", body)
if err != nil {
	return err
}
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
	return err
}
defer res.Body.Close()

const res = await fetch(`${apiUrl}/v1/auth/password/forgot`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": "ada@example.com"
  }),
});
const data = await res.json();

Responseexample

{
  "message": "string",
  "status": "check_your_email"
}

{
  "code": "string",
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "string",
  "errors": [
    {
      "message": "expected length >= 1",
      "location": "body.name"
    }
  ],
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 429,
  "title": "Too Many Requests",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}