ESP - Cheetahmail



Make sure to read the article Email

Input data

Customer Data Platform (CDP) will pull:

  • Your full master contact list with the latest main subscription status CDP cannot pull any additional contact demographics (e.g. First Name, Last Name)

  • Send/open/click/bounce/subscription/unsubscription events

    • Daily: yes

    • Historical load: Cheetahmail only sends the last 7 days of events. Hence, the email event history will be built mostly based on the daily loads. This means that ML models relying on email engagement can only be turned on after two or three months of email pull in order to have enough history.

      Historical data older than 7 days requires an ad hoc export to be performed by CheetahMail (separate S.o.W. with Cheetahmail). CheetahMail should export the files in the exact same format as the daily feeds.

Output data

An xDB is an external “campaign ready” file that lives for 14 days and can be referenced when building a campaign. Columns in the xDB must already exist on the master subscriber list to be usable. Email addresses in the xDB must already exist in the master subscriber list to be usable. xDBs are viewable in the CheetahMail UI here: Reports > Subscriber Reports > Data Upload Report.

If you do not use the xDB functionality, CDP will push the audience and content of your campaigns to the master list (list 0). In such case, you will need to space out your campaigns since a contact can only be linked to a single campaign in this configuration: when exporting to the master contact list new values (including nulls) will overwrite the existing demographic fields from previous exports. This occurs so that the current state of the master contact list always represents the most recent campaign and does not contain any old data.

If you have xDB enabled in Cheetahmail, CDP will push audience and content to xDB tables. Hence, different campaigns can be linked to different xDB tables which allows more flexibility for marketers to run multiple campaigns at the same time.


  • Set up a daily Cheetahmail export to FTP (this is a separate S.o.W. with Cheetahmail)
  • Provide CDP with a Cheetahmail Admin account
  • Provide CDP with an API user
  • Allowlist CDP’s IPs in Cheetahmail
  • Recommended: have the xDB functionality enabled.


  1. Recipients should exist in the Cheetahmail database before any push operation is executed otherwise connector will fail to update their attributes
  2. All field names need to be created in advance
  3. All field names must be uppercase with no special character
  4. All date fields must be date type with format DD/MM/YYYY
  5. Connector will never create new recipients or change subscription status of the recipients. It will only update related fields based on context.
  6. If user belongs to multiple lists, fields that belong to users will be updated for both lists.