Send a campaign to one or more email addresses as a test.
JSON Request Example:
"json_request" 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 (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 Name | Description |
status | Will return SUCCESS if newsletter 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 |