Sections:

1. Description
2. Oempro Version
3. Request Parameters
4. Response Parameters
5. Error Codes

Email.EmailPreview

Description

Sends a preview email to the provided email address

Oempro Version

4+

Request Parameters

SessionID = {string} (required)

Session ID which is needed to authenticate the access. It's optional and required for desktop applications only

Command = {Email.EmailPreview} (required)

API Command

ResponseFormat = {JSON | XML} (required)

Response format

JSONPCallBack = {bool}

Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP

EmailID = {integer} (required)

Email ID number

EmailAddress = {string} (required)

Email address to send preview of the email

ListID = {integer} (required)

List ID number

CampaignID = {integer} (required)

Campaign ID number

AddUserGroupHeaderFooter = {true | false} (default: true, required, v4.1.18+)

If set to false, user group header and footer is not inserted into email. This is only required for opt-in confirmation emails.

Response Parameters

Success = {true | false}

States if there is an error or not

ErrorCode = {integer}

If there is an error, error's code

Error Codes

1

Missing email ID

2

Missing email address

3

Invalid email ID

4

Invalid email address format

5

Missing list ID

6

Invalid list ID

7

Invalid campaign ID

99998

Authentication failure or session expired

99999

Not enough privileges

Stay connected!