Welcome‎ > ‎Version 3‎ > ‎Reference Info‎ > ‎Third Party ESP Info‎ > ‎

Sailthru

Main Site: https://www.sailthru.com/
API Docs: http://getstarted.sailthru.com/api

If no Group Commerce user has access to your Sailthru account, you will need to provide us your Sailthru API key and secret to complete Sailthru integration.

Publisher API Supported Sailthru Functionality:

Sailthru is a supported ESP for our subscription management methods.  These methods wrap some of Sailthru's user management and list management methods.

The Publisher API methods that can update consumers will update a user's email address at Sailthru if the user exists in Sailthru's system and a new email address is provided for the consumer in the Group Commerce API method consumer info parameters.  These methods are: UpdateConsumer, UpdateSubscriptionInfo, and UpdateEmail.

The Group Commerce system will also update users' accounts at Sailthru to contain some custom variables if those variables are available at the time of the request to Sailthru.  They are explained in the table below.  The Publisher API methods that will create or update users in Sailthru's system are AddEmailLead, Purchase, and UpdateSubscriptionInfo.

Key
Explanation
affiliate_createtimestamp If the user was referred by an affiliate, the timestamp (ticks) of the referral.
affiliate_idIf the user was referred by an affiliate, the id of the affiliate.
affiliate_nameIf the user was referred by an affiliate, the name of the affiliate.
affiliate_sourceIf the user was referred by an affiliate, the free text source parameter for the affiliate.
first_affiliate_createtimestampIf the user has been referred by more than one affiliate, the timestamp (ticks) of the first referral.
first_affiliate_idIf the user has been referred by more than one affiliate, the id of the first affiliate.
first_affiliate_nameIf the user has been referred by more than one affiliate, the name of the first affiliate.
first_affiliate_sourceIf the user has been referred by more than one affiliate, the free text source parameter for the first affiliate.
firstNameThe user's first name.
lastNameThe user's last name.
segmentThe segment the user was in when the last request was made to Sailthru.
sourceIf the user was referred by an affiliate, the name of the affiliate.  You may also override this field for use in Sailthru's source report (see below).
zipCodeThe user's zip code.

Some API methods offer additional functionality related to Sailthru.  The following table is a list of variables that may (optionally) be passed as parameters to certain API methods and an explanation of their uses.

Key
Explanation
Supported API Methods
CultureCode
When a Sailthru user is created or updated, the Group Commerce platform will set a custom variable for the user with key CultureCode.  This will default to the default culture code for the user, but if you would like to override this field with any value, you can use the CultureCode key.
AddEmailLead (key/value in AdditionalFields dictionary parameter)
Purchase (key/value in PurchaseTrackingInfo.AdditionalFields dictionary parameter)
UpdateSubscriptionInfo (key/value in AdditionalFields dictionary parameter)
SourceOverride
Sailthru has a source report that uses the custom variable "source" (see docs here).  By default, the Group Commerce platform will set the source to the name of the affiliate that referred the user (or leave it empty if no affiliate).  If you would like to override that behavior, you can use the SourceOverride key.
AddEmailLead (key/value in AdditionalFields dictionary parameter)
Purchase (key/value in PurchaseTrackingInfo.AdditionalFields dictionary parameter)
UpdateSubscriptionInfo (key/value in AdditionalFields dictionary parameter)
sailthru_bid If you have implemented Sailthru purchase tracking on your frontend, you can pass the sailthru_bid value from the tracking cookie on Purchase requests.  The Group Commerce platform will then relay the purchase tracking information to Sailthru.
Purchase (key/value in PurchaseTrackingInfo.AdditionalFields dictionary parameter)
 
If you would like to set additional custom variables for a Sailthru user not defined above, the Group Commerce system will also pass any other value in the additional fields dictionary to Sailthru as a custom variable.

Sample Partial AddEmailLead or UpdateSubscriptionInfo Request Parameters:
Form:

...
AdditionalFields%5B0%5D.Key=SourceOverride&AdditionalFields%5B0%5D.Value=useThisValueInstead&

AdditionalFields%5B1%5D.Key=CultureCode&AdditionalFields%5B1%5D.Value=en-GB&
AdditionalFields%5B2%5D.Key=SomeOtherCustomVariableThatIWantToPassToSailthru&AdditionalFields%5B2%5D.Value=theValueOfTheVariable&
...

Sample Partial Purchase Request Parameters:
Form:

...
PurchaseTrackingInfo.
AdditionalFields%5B0%5D.Key=SourceOverride&PurchaseTrackingInfo.AdditionalFields%5B0%5D.Value=useThisValueInstead&
PurchaseTrackingInfo.AdditionalFields%5B1%5D.Key=sailthru_bid&PurchaseTrackingInfo.AdditionalFields%5B1%5D.Value=528989814&
...

Comments