Email Snapshot Generator

Email Snapshot gives you the ability to save and store HTML and PNG screenshots of emails, including contact-specific personalization. This feature provides you an exact history of which campaigns and personalized content a contact received, allowing your customer support teams to better answer questions from their contact base regarding previous emails sent. For example, if a contact wants to dispute a bill, Email Snapshot allows customer support teams to pull up the exact snapshot of the email sent to review and provide a timely resolution to the dispute. And coming soon, you will have the ability to receive a zip file of batched snapshots pushed to external location of your choice. 

Email Snapshot is enabled at the realm level and can only be enabled by a WhatCounts employee. To inquire about accessing the feature, please contact your Customer Success Manager. 


Generating Snapshots

Snapshots can be generated two ways: within the UI in the Deploy Wizard and with FTP, HTTP, and REST API calls. Email Snapshots are only supported with Normal Deployed campaigns and are only generated on demand when deploying a campaign (they are not generated by default).

From the Deploy Wizard, select Email or Email/SMS from the Deployment Options and continue to step two.

On step two of the Deploy Wizard you will find the Email Snapshot option at the bottom of the page. To activate, check the checkbox.


To note, the file format for Email Snapshots is: <subscriber_id>_<realm_id>_<template_id>_<campaign_id>_<datetime>.

Generating Snapshots via API 

Email Snapshot is supported in the Send, Sub and Send, Launch, and Schedule commands for both the FTP API and HTTP API.  In order to generate an Email Snapshot when sending a message or campaign with either of these APIs, you must include the 'snapshot=1' argument.  See API FTP: Send Mail and API HTTP: Send Mail for details.

Email Snapshot is also supported in several specific Rest API Send commands.  See API: Rest - Send Mail for details.  


Retrieving Snapshots

Snapshots can be retrieved two ways: within the UI on Contact Details pages and with REST API calls. 

To retrieve snapshots from the Contact Details page click the 'SNAPSHOTS' tab on the far right. From the list of snapshots you can view and download the HTML or PNG snapshot in the Actions column.


To note, Email Snapshots files will be stored for a limited period of 12, 24, or 36 months.  This is configured at the Realm level when the feature is enabled. After this period, you will no longer be able to access the snapshot.

Retrieving Snapshots via API

Several Rest API calls provide the ability to retrieve Email Snapshot files of specific type, for specific contacts, or in batches.  See API: Rest - Retrieve Email Snapshot for details.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request


Powered by Zendesk