Send a campaign to one or more email addresses as a test.


JSON Request Example:        

{
  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Newsletters",
  "requestmethod": "SendPreview",
  "details": {
    "newsletter": "{*newsletter_id*}", /* required */
    "subject": "{*email_subject*}",
    "toemail": "{*preview_to_email_address*}", /* required */
    "fromemail": "{*preview_from_email_address*}", /* required */
    "fromname": "{*preview_from_name*}"
  }
}
Null

  "json_request" element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeNewsletters
requestmethodSendPreview


"details" element


Field NameDescription
newsletter
(Required)
ID of campaign to send.  
subject
(optional)
Subject of test email
toemail
(Required)
One or email addresses that are to receive the test email. If more than one, separate by commas.
fromemail
(Required)
Send-from address for test email
fromname
(optional)
Send-from name
Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call. For example, if no Send-from name will be supplied as part of the call, "fromname": "{*preview_from_name*}", should be deleted.  


Successful Response:


"response" element


Field NameDescription
statusWill return SUCCESS if newsletter successfully sent


"response" "data" & "recipients" elements


Field NameDescription
campaignName of campaign sent
itememail address(es) of recipients



Unsuccessful Response:


"response" element


Field NameDescription
statusWill return FAILED if unsuccessful
errormessageText explaining why request failed