Generate reset password email

Reset user password, user will get an email with a link to page where they can update the password.

Query Parameters

client_auth_token string required

Client API token

application/json

Request Body

email email

user email

Responses

• 200
• 403
• 500

---

Successful response

application/json

Schema

Example (from schema)

Successful

---

Schema

success boolean
message string

{
  "success": true,
  "message": "string"
}

{
  "success": true,
  "message": "If your email address exists in our database, you will receive a password recovery link at your email address in a few minutes."
}

Forbidden, api key is missing or invalid

application/json

Schema

Example (from schema)

Example 1

---

Schema

success boolean

Default value: false

message string
status integer

Default value: 401

{
  "success": false,
  "message": "string",
  "status": 401
}

{
  "success": false,
  "message": "You don't have permission!"
}

Internal server error, api will respond with 500 if something went wrong processing the request.

application/json

Schema

Example (from schema)

---

Schema

success boolean required

Default value: false

message string required

Default value: internal server error

error message

{
  "success": false,
  "message": "internal server error"
}

Loading...