API: OpenSRS Email

The API: OpenSRS Hosted Email Developer Hub

Welcome to the API: OpenSRS Hosted Email developer hub. You'll find comprehensive guides and documentation to help you start working with API: OpenSRS Hosted Email as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

reset_email_test

The reset_email_test method sends password reset notification emails to the provided email address(es) for a specified brand. This allows the reseller to experience the emails as they will be received by the end user.

Syntax

{
   <credential_object>,
   "test_email_rcpt" : <email id>,
   "brand" : <brand id or name>
}
FieldsObligationDefinition/Value
test_email_rcptrequiredEmail ID where test emails will be sent
brandrequiredbrand id or brand name. If brand name, then company info must be specified (see below)
companyconditionalEither 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

FieldsObligationDefinition/Value
successalways returnedWhether the request was successful or not. Either true or false
error_numberreturned if success == falseA number that represents the error
errorreturned if success == falseA text string that explains the error

Updated less than a minute ago

reset_email_test


The reset_email_test method sends password reset notification emails to the provided email address(es) for a specified brand. This allows the reseller to experience the emails as they will be received by the end user.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.