POST v1/Customers/PasswordReset/Email
Reset customer password
URI template
v1/Customers/PasswordReset/Email?isSecurityAnswerRequired={isSecurityAnswerRequired}Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
isSecurityAnswerRequired |
Whether or not a security answer is required to reset the user's password |
boolean |
Default value is True |
Body Parameters
InPasswordEmailResetName | Description | Type | Additional information |
---|---|---|---|
string |
Required |
||
SecurityAnswer | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Email": "sample string 1", "SecurityAnswer": "sample string 2" }
application/xml, text/xml
Sample:
<InPasswordEmailReset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound"> <Email>sample string 1</Email> <SecurityAnswer>sample string 2</SecurityAnswer> </InPasswordEmailReset>
Response Information
Resource Description
Known internal errors are BadRequest, CustomerNotFound, Error, AccessDenied
booleanResponse Formats
application/json, text/json
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>