Send a campaign to one or more email addresses as a test.
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?> <xmlrequest> <username>JohnDoe</username> <usertoken>abc123abc123abc123abc123</usertoken> <requesttype>Newsletters</requesttype> <requestmethod>SendPreview</requestmethod> <details> <newsletter>{newsletter_id}</newsletter> <!-- required --> <subject>{email_subject}</subject> <toemail>{preview_to_email_address}</toemail> <!-- required --> <fromemail>{preview_from_email_address}</fromemail> <!-- required --> <fromname>{preview_from_name}</fromname> </details> </xmlrequest>
<xmlrequest> element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Newsletters |
requestmethod | SendPreview |
<details> element
Field Name | Description |
newsletter (Required) | ID of campaign to send. |
subject | 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 | Send-from name |
Successful Response:
<response> element
Field Name | Description |
status | Will return SUCCESS if preview was successfully sent |
<response> <data> & <recipients> elements
Field Name | Description |
campaign | Name of campaign sent |
item | email address(es) of recipients |
Unsuccessful Response:
<response> element
Field Name | Description |
status | Will return FAILED if unsuccessful |
errormessage | Text explaining why request failed |