Skip to main content
POST
Send a password reset email

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
resetPasswordClientUrl
string
required

URL the user is redirected to when they reset their password. Use the control plane URL followed by /reset-password.

Example:

"https://app.example.com/reset-password"

email
string
required

Email address of the user requesting a password reset.

Example:

"user@example.com"

Response

The forgot-password email has been sent.

Password reset link sent to the user.