reset_email

Syntax

{
   <credential_object>,
   "test_email_rcpt" : <email id>,
   "brand" : <brand id or name>
}

Fields	Obligation	Definition/Value
test_email_rcpt	required	Email ID where test emails will be sent
brand	required	brand id or brand name. If brand name, then company info must be specified (see below)
company	conditional	Either a company id or company name. Must be provided if using brand name

Response

Success Response

{
   "success" : true,
   "audit" : "sort86_5ebe15f419"
}

Fail Response

{
   "success" : false,
   "error_number" : 5,
   "error" : "Request badly formatted (missing required field, or field is not the correct data type)",
   "audit" : "able41_5ebe1727a"
}

Response Fields

Fields	Obligation	Definition/Value
success	always returned	Whether the request was successful or not. Either true or false
error_number	returned if success == false	A number that represents the error
error	returned if success == false	A text string that explains the error