The purpose of this call is to allow the user to create a simple one-criteria autoresponder (“AR”) which has an optional fixed criteria of the NEW contact being added to a specified list, with that contact receiving a single email immediately (default timing behavior) after being added to the target database (list) and list (tag). The call also provides for submitting HTML to create the associated email content.


JSON Request Example


{
  "username": "DRBrel2",
  "usertoken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "requesttype": "Autoresponders",
  "requestmethod": "AddAutoresponder",
  "details": {
    "list": "{*list-id or list-name*}", /* required */
    "title": "{*autoresponder title*}", /* required */
    "subject": "{*autoresponder subject*}", /* optional */
    "htmlbody": "{*HTML content*}", /* required */
    "tag": "{*tag-id or tag-name*}", /* optional. If name is not found it will create the tag */
    "fromname": "{*from name*}", /* optional, defaults to list settings */
    "fromemail": "{*from email*}", /* optional, defaults to list settings */
    "replytoemail": "{*reply-to email*}" /* optional, defaults to list settings */
  }
}

"json_request" element


Field NameDescription
usernameUsername used to log in to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeAutoresponders
requestmethodAddAutoresponder



"details" element


Field Name
Description
list  - (required)The list (database) ID or name the autoresponder is targeting
title - (required)The name you wish to give the autoresponder
subject - (optional)The subject line of the AR email campaign that will be sent when autoresponder is fired. If not provided, the "title" value will be used.
htmlbody - (required)The properly-JSON-escaped HTML code for the AR email campaign
tag - (optional)The tag (list) ID or name that subscriber must be in to trigger the autoresponder. If value supplied but that tag (list) does not exist, system will create a new one. If value not provided, no target tag (list) membership will be used as the criteria.
fromname - (optional)"From" text to be used in AR campaign. If not provided, will use list (database) default.
fromemail - (optional)
"Send-from" email address to be used for AR campaign. If not provided, will use list (database) default.
replytoemail - (optional)
"Reply-to" email address to be used for AR campaign. If not provided, will use list (database) default.



Successful Response


"response" element


Field Name
Description
statusWill return "SUCCESS" if the autoresponder and AR email campaign were successfully added


Unsuccessful Response


"response" element


Field Name
Description
statusWill return "FAILED" if call request unsuccessful
errormessageText explaining general reason request failed