Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.smile.io/llms.txt

Use this file to discover all available pages before exploring further.

Install the Dotdigital integration

To install and configure the Smile and Dotdigital integration:
  1. In Dotdigital, create a new API user.
    • For the Description, enter Smile.io.
    • For Rate limiting, select Tiered.
  2. In Smile Admin, install the Dotdigital integration/.
  3. Follow the instructions to connect the integration to Dotdigital using the API user you just created.
  4. Once connected, on the Dotdigital integration settings page, select the address book you want to sync your rewards program information to, and click Sync address book.
Note: The first data sync can take anywhere from a few minutes to a couple of hours, and only needs to happen once. The exact duration will depend on the number of customers in your Smile account.

Data syncing

Here’s what to expect with how data is synced from Smile to Dotdigital:
  • Customers in Smile are matched to Dotdigital contacts by email address, and synced to the address book you selected.
  • If a customer already exists in Dotdigital with the same email address, their data will be updated with the latest information from Smile.
  • If a customer does not exist in Dotdigital with the same email address, a new contact will be created with the information from Smile.

Data fields

Once installed and connected, Smile will sync the following data fields in Dotdigital for each customer in the address book you selected.
Data field nameData typeDescription
SMILE_POINTS_BALANCENumberThe customer’s current points balance.
SMILE_REFERRAL_URLStringThe customer’s unique referral URL. Used to share with friends as part of the referral program.
SMILE_VIP_TIER_IDNumberThe ID of the customer’s current VIP tier.
SMILE_VIP_TIER_NAMEStringThe name of the customer’s current VIP tier.
SMILE_STATEStringThe customer’s state (member, candidate, or disabled).
You can use these data fields in your email templates to display an individual’s loyalty program information, or use it to segment your audience for targetted email sending.