Site Home
API Reference
LoginTry for Free

Reset Password

post
https://{application_vanity_domain}/api/v1/password-reset/reset-password
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Reset Password Request JSON object

string
length ≥ 1

The email auth code that will be used to authorize the request. This value should be provided if a password reset email was sent containing a verification link. If provided then the passwordResetCode, requestCode and verificationCode fields must be null.

string
length ≥ 1

The password reset code that will be used to authorize the request. This value should be provided if a password reset link was used. If provided then the emailAuthCode, requestCode and verificationCode fields must be null.

string
length ≥ 1

A code that is used to identify the current password reset request. This value should be provided if a password reset email was sent containing an OTP. If provided then the emailAuthCode and passwordResetCode fields must be null.

string
length ≥ 1

The verification code that was sent to the user's email. This value should be provided if a password reset email was sent containing an OTP. If provided then the emailAuthCode and passwordResetCode fields must be null.

password
required
length ≥ 1

The user's new password.

boolean
Defaults to false

If set to true, then the Password Updated email will not be sent after the user's password is updated.

Responses

Updated 6 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago