POST v1/Customers/PasswordReset

Reset customer password

URI template

v1/Customers/PasswordReset

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Email		string	Required
SecurityAnswer	A customer's GUID can also be sent in place of SecurityAnswer	string	Required
NewPassword		string	Required
EmailLinkAuthGuid	The RedisKey generated and sent to an Engage user after they request to have their email reset by clicking "Forgot Password". Reference v1/Customers/PasswordReset/Email/Link call for RedisKey generation and sending of email	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "SecurityAnswer": "sample string 2",
  "NewPassword": "sample string 3",
  "EmailLinkAuthGuid": "sample string 4"
}

application/xml, text/xml

Sample:

<InPasswordReset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound">
  <Email>sample string 1</Email>
  <EmailLinkAuthGuid>sample string 4</EmailLinkAuthGuid>
  <NewPassword>sample string 3</NewPassword>
  <SecurityAnswer>sample string 2</SecurityAnswer>
</InPasswordReset>

Response Information

Resource Description

Known internal errors are BadRequest, AccessDenied

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>