Reset password

Resets the user's password from the reset password token.

post

Header parameters

Brand-URLstringRequired

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 ResetPassword.

emailAddressstring · min: 1Required

This represents the email of the user.

Example: [e-mail]

tokenstring · min: 1Required

This represents the token of the user.

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9

newPasswordstring · min: 1Required

This represents the new password of the user.

Example: newpassword

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

databooleanOptional

400

Your token was invalid.

application/json

404

The user was not found in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/users/reset-password

HTTPcURLJavaScriptPython

POST /api/v1/users/reset-password HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "emailAddress": "[e-mail]",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
  "newPassword": "newpassword"
}

application/jsontext/jsonapplication/*+json

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