Forgot password

Sends to the user an email with a link to reset their password.

post

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Body

application/jsontext/jsonapplication/*+json

This is the model class for ForgotPassword.

emailAddressstring · email · min: 1Required

This represents the email of the user.

Example: [e-mail]

resetPasswordLinkstring · uri · min: 1Required

This represents the reset password link to be sent to the user. When the user clicks on the link, they will be redirected to the forgot password page and in this link includes the token parameter which is used to verify the user.

Responses

200

The request was successful.

application/json

404

The user was not found in the database.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

POST /api/users/forgot-password HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "emailAddress": "[e-mail]",
  "resetPasswordLink": "https://example.com"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}