POST v1/Customers/PasswordReset/Email/Link

Send Email with Reset Password Link

URI template

v1/Customers/PasswordReset/Email/Link

Request Information

URI Parameters

None.

Body Parameters

InPasswordEmailWithLinkReset
NameDescriptionTypeAdditional information
Email

string

Required
CompanyUrl

The external company address (not Aloha Online external address) that will handle redirect authorization

string

None.
RedirectLink

Route that handles redirect authorization

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Email": "sample string 1",
  "CompanyUrl": "sample string 2",
  "RedirectLink": "sample string 3"
}

application/xml, text/xml

Sample: 
<InPasswordEmailWithLinkReset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound">
  <CompanyUrl>sample string 2</CompanyUrl>
  <Email>sample string 1</Email>
  <RedirectLink>sample string 3</RedirectLink>
</InPasswordEmailWithLinkReset>

Response Information

Resource Description

True if email is sent and value is saved to redis

boolean

Response Formats

application/json, text/json

Sample: 
true

application/xml, text/xml

Sample: 
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>