HTTP Interface : Concept

A HTTP Interface is a simple way of triggering actions within Pure Response. A HTTP request is made to a set destination at a base location, with a set of data parameters, these data parameters dictate how the processor at the destination manipulates these and triggers an action based on these.

Example : List Builder

  • Most commonly used interface is our List Builder
  • Acts as a signup processor
  • A HTTP (POST/GET) request is made to this interface, and the parameters dictate how the interface parses this incoming request
  • For instance the parameters might be the profile, the listname, the recipients email address, their custom data etc.

In it's most basic iteration, a HTML form can be directly used, HTML forms are designed to trigger "HTTP Requests".

HTML Example:
<form action="" method="post">
    <input type="hidden" name="accName" value="PROFILE-NAME" />
    <input type="hidden" name="listName" value="MASTER-LIST" />
    <input type="hidden" name="doubleOptin" value="FALSE" />
    <input type="hidden" name="successUrl" value="NO-REDIRECT" />
    <input type="hidden" name="errorUrl" value="NO-REDIRECT" />
    <label for="email"> Email Address : </label>
    <input type="email" name="email" id="email" required />
    <input type="submit" value="Sign Up!" />
  • Form makes a request to
    (or your http://{~customDomain~}/interface/list.php - HTTPS is ONLY available @
  • The HTTP method being used to make this request is POST
  • The hidden data is the configuration that dictates how the list builder interface deals with this request, and regardless of "how" this is sent (HTML form / URL / cURL / Server code) these must be sent.
    • accName in this instance dictates the profile name that the list resides in.
    • listName is the list to add this recipient to, and must already exist in accName
    • doubleOptin is an indicator to trigger a optin verification message, DO NOT set to true, unless you have a signup automation that sends out a custom double optin message.
    • successUrl is a redirection option, that is used in HTML forms to redirect the user after submission, assuming OK is returned
    • errorUrl is a redirection option, that is used in HTML forms to redirect the user after submission, if there is an error returned
  • Each request must feature either an EMAIL input or a MOBILE data parameter, otherwise there is obviously no valid recipient to add to the list.
  • Custom data is transported as key value pairs, where the name of the data parameter is the custom field name in the list, i.e. location, and the value is the recipient specific value for that custom field.
  • The response for success is the string "OK" (or "OK : xxxx" in the case of automated list upload)
  • The response for error is the string "Error : Error Message".
Simply. Request, with valid required parameters, and optional parameters - Response, with success or error string.