LassoMailer - API Reference

The LassoMailer API enables signup via XHR requests to public LassoMailer lists. A successful signup triggers a double opt-in confirmation email, configured in the Opt-In section of the LassoMailer Settings area.

Two methods are provided, "list" and "add".

All requests to the LassoMailer API require a valid API key, which are generated in the Settings > API Keys section.

List

The List method returns publicly available lists that a member can subscribe to.

URL:

• /lasso9/LassoMailer/api/v1/lists.xhr

Parameters:

• key (String) - API key, Mandatory

Example request: http://{your.domain.com}/lasso9/LassoMailer/api/v1/lists.xhr?key=56KJHDF987HJKGHJGK

Example Response:

{
   "availableColumns":[
      "firstname",
      "lastname",
      "email",
      "company",
      "country",
      "phone"
   ],
   "data":[
      [
         "28735E6AA7F376FDF3",
         "Announcements"
      ],
      [
         "28735E6AA4F376FD61",
         "Newsletters"
      ]
   ],
   "error":"No Error."
}

Add

The Add method subscribes a member to one or more lists and triggers the double opt-in email for confirmation.

URL:

• /lasso9/LassoMailer/api/v1/add.xhr

Parameters:

• key (String) - API key, Mandatory
• email (String) - Email address of member, Mandatory
• firstname (String) - First name of member, Optional
• lastname (String) - Last name of member, Optional
• company (String) - Company name, Optional
• country (String) - Country name, Optional
• phone (String) - Phone number, Optional

One of either the following methods of supplying the list(s) must be used:

• listid (String) - A single string containing the list ID.
• lists (Array) - One or more strings of list ID delimited by a comma.

Example request:
http://{your.domain.com}/lasso9/LassoMailer/api/v1/add.xhr?key=56KJHDF987HJKGHJGK

{
    "email" : "someone@example.com",
    "listid" : "28735E6AA7F376FDF3"
}

Example Response:

{
    "error":"No Error.",
    "msg":"Awaiting Opt-In."
}