📝💻 Code Samples

Useful code samples

🏡 Home / ⛵ Sailthru / 🌐📚 Community Docs / 📝💻 Code Samples

Code Samples

API Requests

Used either with the API clients, or with the web UI.

Custom Events

Sends API events to initiate LOs and triggers.

Uses: POST - event vars are optional and can be completely omitted if not used.

{
  "id" : "email_address",
  "event"  : "event_name",
  "vars" : {
    "url" : "http://example.com/123",
    "name" : "Widget"
  }
}

Lookup Profile by extID

This request returns the profile data for the customer with that ID. The email/SID can be used with Native search to show the normal profile view.

Uses: GET- user

{
  "id":"extID_to_lookup",
  "key":"extid"
}

Merge Profiles by Email Address

Other keys can be used, but email is simplest and easiest to use.

This works whether the old email or the new one has the extid. In either case the 'new_email_address' will be the email of the account, the extid will be assigned, and the other profile is deleted. If the old profile was a hardbounce, it will remain to prevent future sends.

Uses: POST - user

{
    "id":"old_email_address",
    "key": "email",
    "keys":
        {
            "email":"new_email_address"
        },
    "keysconflict":"merge"
}

Success response:

{
    "ok" : true
}

Content Library

Lookup Product (SKU)

{* Searches for sku match, returns first result. Uses 'replace' to remove any spaces *}
{response = personalize({"algorithm": "custom", "custom_keys": [replace(sku, " ", "")], "custom_key_type": "sku","include_vars":true})}
{skuLookupResponse  = response[0]}

!! WARNING !! There is a hidden property from the UI called 'expire_date' which will prevent some products/articles from being returned unless this property is added: "allow_expired":true This hidden value shows when the product will expire, but the only way to view the field is after this special parameter is added.

Currency

Format Currency

{* add $ to a float number and also handling signs *}
{formatCurrency = lambda x: (x < 0 ? "-$" : "$") + (x < 1 && x > -1 ? "0" : "") + number(abs(x),2)}

Format Currency (French)

{* add $ to a float number and also handling signs *}
{formatCurrencyFr = lambda x: (x < 0 ? "-" : "") + (x < 1 && x > -1 ? "0" : "") + replace(replace(number(abs(x),2), ","," "),".",",") + " $"}

Dates

Show date in bilingual format (EN + FR)

Required variables: input_date = your date(supported formats: All main formats. If using '/' must be MM/DD/YY. Use YYYY if <2000 language = the current language as a 2-letter string

{input_date = replace(input_date, "T", " ")}

{* Initializes date-related variables and formats a given date into a list with various date elements *}
{french_months = ["month", "janvier", "février", "mars", "avril", "mai", "juin", "juillet", "août", "septembre", "octobre", "novembre", "décembre"]}
{date_components = [input_date, time(input_date), int(date("yyyy", time(input_date))), int(date("M", time(input_date))), int(date("d", time(input_date))), (int(date("d", time(input_date))) == 1 ? int(date("d", time(input_date))) + "er" : int(date("d", time(input_date))))]}
{initializeDateFormatting = lambda input_date: map([french_months, date_components], lambda x: x)}

{* Displays the date in a specified language format, French or default (English) *}
{displayFormattedDate = lambda language: language == "fr" ? (date_components[5] + " " + french_months[date_components[3]] + " " + date_components[2]) : (date("MMMM", date_components[1]) + " " + date("d, yyyy", date_components[1]) )}

Example

{input_date = "2023-11-01T19:00:34.733Z"}
{language = "fr"}

Formatted date: {displayFormattedDate(language)}

Gives: Formatted date: 1er novembre 2023

Event Log for Messages Canceled with assert() + cancel()

If using assert() + cancel(), it is really beneficial to log the failures. This can be done with the use of Template Triggers - only works with HTML Templates.

In the HTML template, go to 'Triggers' (the last tab, might have to have this enabled on your space), add a Trigger for the 'cancel' event with a time of 0 minutes and use the 'Custom Zephyr Script' Action with this as the code:

{thisEvent = {"event":"X Template Failure","date":date("E, d MMM yyyy HH:mm:ss Z", time("now")),"cartSkus":cartSkus,"failureMessage":event.failure_message}}

{logLimit = 50}
{eventLogs = profile.vars.eventLog_Failures}

{*If the existing log is at or past the logLimit(50), trim the oldest entries and add the new event*}
{if length(eventLogs) >= logLimit }
{eventLogs = slice(eventLogs, length(eventLogs) - (logLimit - 1))}
{else if !eventLogs}
{eventLogs = []}
{/if}

{push("eventLogs", thisEvent)}

{api_user({"vars": {"eventLog_Failures": eventLogs}})}

This will capture any failures and log the data to the customers profile. Custom data can be added as needed. Other templates can use the same code and share the eventLog_Failures field.