Email Scheduling

GET the HTML Preview of an Email Campaign Activity

Changed on

Use this method to get the HTML preview of an email campaign activity. The HTML preview allows you to verify how the email campaign activity will look before you send it to contacts.

Custom code emails (format_type 5) use the Constant Contact account owner's contact information to process contact, custom field, and account variables in the preview.

This method returns the HTML preview encoded as a JSON string. You will need to decode the string before you can use it as valid HTML.

get/emails/activities/{campaign_activity_id}/previews

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/emails/activities/{campaign_activity_id}/previews
  • Auth
    • OAuth 2
      Implicit: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Scopes: campaign_data
    • or OAuth 2
      Authorization code: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Token URL: https://authz.constantcontact.com/oauth2/default/v1/token scopes: campaign_data

Path parameters

campaign_activity_idstring uuid required

The unique ID for an email campaign activity.

Response

Request successful.

campaign_activity_idstring

The unique ID for an email campaign activity.

from_emailstring

The "from email" email header for the email campaign activity.

from_namestring

The "from name" email header for the email campaign activity.

preheaderstring

The email preheader for the email campaign activity. Only <code>format_type</code> 3, 4, and 5 email campaign activities use the preheader property.

preview_html_contentstring

An HTML preview of the email campaign activity.

preview_text_contentstring

A plain text preview of the email campaign activity.

reply_to_emailstring

The email "Reply To Email" field for the email campaign activity.

subjectstring

The email "Subject" field for the email campaign activity.

Example response

{
  "campaign_activity_id": "4c08372c-957a-48b5-bc45-72c7f00796cd",
  "from_email": "jdodge@constantconatct.com",
  "from_name": "Jake Dodge",
  "preheader": "You don't want to miss this.",
  "preview_html_content": "<html><body> <a href=\\\"http://www.constantcontact.com\\\">Visit ConstantContact.com!</a> </body></html>",
  "preview_text_content": "Email Content",
  "reply_to_email": "jdodge@constantcontact.com",
  "subject": "Informed Daily Digest"
}

Changes