Experian CheetahMail Connector Setup Guide

Experian CheetahMail Connector Setup Guide

by roshan_gonsalko on ‎04-05-2016 04:12 PM - edited 2 weeks ago by (587 Views)

This article describes how to set up the Experian CheetahMail connector in your Universal Data Hub account.

In this article:

Table of Contents Placeholder

Connector Actions

Action Name AudienceStream EventStream

Send Email to Subscriber

(Advanced API Call - ebmtrigger1)

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Send Email to Subscriber (Advanced API Call - ebmtrigger1)

Parameters

Parameter Description
email
  • Required
  • Target email address
eid
  • Required
  • Event ID tied to target mailing template
aid Affiliate ID for target mailing
from_address Sender/From email address
from_text Text part of from header
replyto Reply-To header
Engage Global Suppression Tool (GST)
certify Send with a third party certification stamp
mtype Certified message type
test    Test flag to trigger non-deployed event
part Mailing part to use for the test
Preferred Content Type
  • Optional
  • HTML=Optional
    A specialized instance of a PARAM value that indicates the preferred content type:
    • 0 – Text only
    • 1 HTML/Text multipart
    • 2 – Rich Text/Text multipart
Email CB Data Fields to Set
  • Optional
  • Add one line item per field (line items provided are pipe delimited)
  • cb=Optional
    A list of client-defined suppression bit indexes for the Global Suppression Tool (GST) to change, ranging from 1 to 25.
  • If the cb parameter is passed, the b parameter must also be specified with a value of 0 or 1.
  • Indicates whether the standard stoplist should be included when evaluating suppression for an address.
Email REQ Data Fields to Set
  • Optional
  • Add one line item per field (line items provided are pipe delimited)
  • req=Optional
    Specify required personalization fields that must be non-empty for success.
  • Looping dynamic content fields may only be required explicitly, replacing * with appropriate values (ITEMS.*).
  • Alternatively, setting req to a value of 1 specifies that all personalization fields present must be non-empty.
Set Dynamic Content Tags/Parameters
  • Optional
  • Add one line item per field (line items provided are pipe delimited).
  • PARAM=
    The value of any upper case parameter is made available for substitution into the email in place of a tag consisting of two (2) percentage signs, the parameter name, and two (2) percentage signs.
    • Example:
      For PARAM, the tag would be "%%PARAM%%.
  • Uppercase parameters start with A- Z or _, followed by any number of characters A- Z, 0- 9, or underscore ( _).
  • Values are URL-decoded before substitution.
  • Tags referring to parameters not supplied in the API call are replaced with an empty string.
  • There is no size limit to values (entire order tables can be supplied).
  • There is no versioning of the parameters for the three (3) different types of email creative (text, html, rich text/aol).
  • If variable content needs to be formatted differently depending on creative, the API call should supply the different versions with different parameter names.
  • Mailing should be set up to use version-appropriate tags.
  • The parameters T, TRACK, and EMAIL are reserved for internal use.
  • The API is error-tolerant for PARAM names.
  • If a PARAM is supplied that does not exist in the template, it will be silently ignored.
  • Ensure that you proofread all names so that they are not lost due to a spelling error.
Enable Subscriber Lookup via getuser1 API Call
  • Enabling this option triggers an extra API call where the target subscriber is looked-up up using the getuser1 API call.
  • The result is matched against the Subscriber List ID configured in the next section, and if satisfied an email is sent via ebmtrigger1 API call.

    The AID returned from this API call will be used regardless and will override the configuration in the "Email General Data Fields to Set" section unless the "Exclude using AID returned from Subscriber Lookup" is checked.

Exclude using AID returned from "Subscriber Lookup"
  • This option is only used when "Subscriber Lookup" is also enabled.
  • If checked the AID returned for the "Subscriber Lookup" API call will not be included in the subsequent ebmtrigger1 API call, otherwise the AID from "Subscriber Lookup" will be included and override the configurations in the "Email General Data Fields to Set" section.
Target Subscriber List ID to match against Subscriber Lookup ( getuser1 API Call)
  • This option is only used when "Subscriber Lookup" is also enabled.
  • email
    See the "Email General Data Fields to Set" row in this table.
    • Required
    • The email address provided in "Email General Data Fields to Set" section will be used to lookup the subscriber.
  • Target Subscriber List ID
    • Required
    • The subscriber list ID that is used to match against getuser1 API call response.

Vendor Documentation

Additional information is contained in the following vendor documentation attachments to this article:

  • CheetahMail External API Best Practices for Client Hosted Solution
  • Retrieve Authentication Cookie: login1 API Service 
  • Event Based Mailing Trigger: ebmtrigger1 API Service