forgot Password With Id

POST {{baseUrl}}/api/user/forgot-password

Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password.

Request Body

{"applicationId"=>"<uuid>", "changePasswordId"=>"<string>", "loginId"=>"<string>", "sendForgotPasswordEmail"=>"<boolean>", "email"=>"<string>", "username"=>"<string>", "eventInfo"=>{"deviceDescription"=>"<string>", "deviceName"=>"<string>", "deviceType"=>"<string>", "ipAddress"=>"<string>", "location"=>{"city"=>"<string>", "country"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>", "region"=>"<string>", "zipcode"=>"<string>", "displayString"=>"<string>"}, "os"=>"<string>", "userAgent"=>"<string>"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;changePasswordId&quot;:&quot;\u003cstring\u003e&quot;}