Use this endpoint to test what an email campaign message will look like by sending it to a maximum of 5 recipients.
NOTE: Any dynamic content included in the campaign will not be processed because test send does not merge data from a contact list when sending the test message.
Click a method to view its documentation
Privileges required: campaign:create
When creating a new email campaign, template_type
is automatically set to CUSTOM; There are several campaign properties that are optional by default, but become REQUIRED once another property is used. See Structure table below for specific properties.
Privileges required: campaign:send
Send the email campaign message specified by the campaignId
path parameter to the email addresses (maximum of 5) in the email_address
array in the JSON request payload. You can preview email campaign messages with a status of DRAFT, SENT, and SCHEDULED.
email_content
)text_content
)NOTE: You cannot preview XHTML formatted email campaign messages (email_content_format
= XHTML).
POST: https://api.constantcontact.com/v2/emailmarketing/campaigns/{campaignId}/tests |
|||
name |
type |
default |
description |
---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
campaignId |
path |
Specifies the email campaign message to retrieve (GET) |
{ "personal_message": "This is a test send of the email campaign message.", "email_addresses": ["address1@example.com", "address2@example.com","address3@example.com"], "format": "HTML_AND_TEXT" }
code |
description |
---|---|
200 |
Request was successful |
400 |
Bad Request:Either JSON was malformed or there was a data validation error |
401 |
Authentication failure |
404 |
No campaign found for provided campaignId |
406 |
Unsupported accept header value, must be application/json |
415 |
Unsupported content-type in the header, use application/json |
500 |
Internal server error occurred |
property |
type(max length) |
description |
---|
{ "format": "HTML_AND_TEXT", "personal_message": "This is a test send of the email campaign message.", "email_addresses": [ "address1@example.com", "address2@example.com", "address3@example.com" ] }