Request a password-reset email

POST/api/auth/request-password-reset

Request body

requiredapplication/json

emailstring<email>required

redirectTostring

captchaTokenstring

Responses

200

Sent (or silently accepted — no user enumeration).

successbooleanrequired

Allowed:true

tokenstring

Access token (also delivered via Set-Cookie in cookie mode).

refreshTokenstring

Rotation token for /api/auth/update-session.

redirectboolean

Whether url should be navigated to.

urlstring

Validated landing URL.

userUser

Show properties

idstring

emailstring<email>

namestring

imagestring

emailVerifiedboolean

400

Invalid body or an untrusted redirect parameter.

successbooleanrequired

Allowed:false

reasonstringrequired

403

Cross-site request rejected by CSRF validation (Fetch Metadata / Origin). Same-origin and explicitly trusted origins are unaffected.

successbooleanrequired

Allowed:false

reasonstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Bodyapplication/json

emailstring*redirectTostringcaptchaTokenstring

Request

curl -X POST 'https://your-deployment.convex.site/api/auth/request-password-reset' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "user@example.com",
  "redirectTo": "string",
  "captchaToken": "string"
}'

const response = await fetch("https://your-deployment.convex.site/api/auth/request-password-reset", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"email\": \"user@example.com\",\n  \"redirectTo\": \"string\",\n  \"captchaToken\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://your-deployment.convex.site/api/auth/request-password-reset",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"email\": \"user@example.com\",\n  \"redirectTo\": \"string\",\n  \"captchaToken\": \"string\"\n}",
)

Response

{
  "success": true,
  "token": "string",
  "refreshToken": "string",
  "redirect": true,
  "url": "string",
  "user": {
    "id": "string",
    "email": "user@example.com",
    "name": "string",
    "image": "string",
    "emailVerified": true
  }
}

{
  "success": false,
  "reason": "invalid_body"
}

{
  "success": false,
  "reason": "invalid_body"
}