Skip to main content
POST
/
v1
/
users
/
password-reset-request
Password Reset Request Operation
curl --request POST \
  --url https://api.iklim.co/v1/users/password-reset-request \
  --header 'Content-Type: application/json' \
  --data '
{
  "userName": "name@email.com",
  "passwordResetPageLink": "https://ui.iklim.co/reset-password"
}
'
{
  "userName": "<string>",
  "userId": "<string>",
  "token": "<string>",
  "tokenExpirationEpoch": 123
}

Body

application/json
​
userName
string
required

User Name in E-Mail Format

Example:

"name@email.com"

​
passwordResetPageLink
string
required

The Link to The Page Where New Password Will Be Entered During Password Reset. Userid (u) and Password Reset Token (t) Are Added As Parameters into The Link.

Example:

"https://ui.iklim.co/reset-password"

Response

Successful Password Reset Request

​
userName
string

Username

​
userId
string

User Identifier

​
token
string

Password Reset Token

​
tokenExpirationEpoch
integer<int64>

Password Reset Token Expiration Date in Epoch Seconds