Reset User Password

Description

This API enables you to reset the password of a user of your Catalyst application. When this API is called, an email will be sent to the user's email address with a password reset link. The user can configure a new password for your application and save it, upon clicking the link.

Request URL

https://api.catalyst.zoho.com/baas/v1/project/{project_id}/project-user/forgotpassword

project_id - The unique ID of the project

Request Headers

Content-Type: application/json
PROJECT_ID: {project_id}

Note: Catalyst does not authenticate this API request. Therefore, you need not pass an OAuth token or specify any scopes.

Request Method

POST

Request JSON Properties

Attributes

Data Type

Mandatory

Max Size

Description

user_detailsShow properties

JSON

Yes

The JSON that contains the details of the user

user_details Properties

Attribute	Data Type	Mandatory	Max Size	Description
first_name	String	No	100	First name of the user
last_name	String	No	100	Last name of the user
email_id	String	Yes	N/A	Email address of the user

platform_type

String

Yes

N/A

Accepted values are web, android, ios

redirect_url

String

200

The URL to be redirected to, after the user resets the password

SDK Documentation

Reset Password- Java SDK

Reset Password- Node.js SDK

Reset Password- Web SDK

Curl

Sample Request


				curl -X POST \
 https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user/forgotpassword \
  -H "Content-Type: application/json" \
  -H "PROJECT_ID: 1010309726" \
  -d '{
	"user_details":{
		"email_id":"p.boyle@zylker.com"
	},
	"platform_type":"web"
}'

Sample Response


				{
    "status":"success",
    "data":"Reset link sent to your p.boyle@zylker.com email address. Please check your email :)"
}