Send a password reset link

POST

auth

recover

A valid request URL is required to generate request examples

{
  "sent": true,
  "message": "If the address has an account, a message is on its way."
}

Authorizations

apikey

string

header

required

Your publishable (pb_pk_…) or secret (pb_sk_…) key.

Authorization

string

header

required

The signed-in person's access token.

Body

application/json

string

required

The account's email address.

redirect_to

string | null

Where the link in the email should send the person afterwards. Must be an allowed redirect URL for this environment.

Response

Success.

sent

boolean

required

message

string

required

A human-readable message.

A valid request URL is required to generate request examples

{
  "sent": true,
  "message": "If the address has an account, a message is on its way."
}

Storage

AI

Flows

Inbound webhooks

Health

Accounts and sign-in

Social sign-in

Company sign-in (SAML)

Two-step verification

Sessions

Organizations and teams

User API keys

Devices

Realtime

Send a password reset link

Authorizations

Body

Response