VIP tiers in the JavaScript SDK
The JavaScript SDK now supports the ability to get VIP tiers, get a single VIP tier by ID, and access preloaded VIP tiers. Each VIP tier object includes nested entry rewards, making it easy to display tier details and benefits in custom-built UIs.Earning rules in the JavaScript SDK
The JavaScript SDK now supports the ability to get earning rules and access preloaded earning rules. Use these methods to display the ways customers can earn points in custom-built UIs and interfaces.Get points settings endpoint
The REST API now supports the ability to get points settings. This endpoint can be used to retrieve branding information about the account’s points currency, making it possible to display the customized points label in customer balances or elsewhere (e.g. “10 Coins” instead of “10 Points”).New JavaScript SDK release
Smile’s JavaScript SDK, Smile.js, has been re-written from the ground up and is now available as a standalone library from our CDN or via npm. The library focuses on providing tools to efficiently fetch and display customer and loyalty program information, and is no longer bundled with Smile UI.Refer to the JavaScript SDK documentation for more information on how to use, include, and initialize the JavaScript SDK either as a standalone library or alongside Smile UI.Smile UI method deprecations
All methods on theSmile object within Smile UI are now deprecated and should be replaced with the corresponding methods from the JavaScript SDK instead. Deprecated methods include:Smile.createActivity()Smile.customerReady()Smile.fetchAllCustomerPointsProducts()Smile.fetchAllPointsProducts()Smile.fetchAllRewardFulfillments()Smile.fetchCustomer()Smile.fetchPointsProduct()Smile.formatPoints()Smile.purchasePointsProduct()Smile.ready()
Create activities using a customer’s email address
The create an activity endpoint now supports customer lookup by email address or Smile Customer ID. This makes it possible to use this endpoint from contexts where the Smile Customer ID may not be available (e.g. within a Klaviyo Flow webhook).Legacy Private Key deprecation
Using a Legacy Private Key to authenticate with the REST API is no longer possible. Going forward, only API keys and OAuth Access Tokens can be used.Unreviewed app installation restriction
The installation of draft (unreviewed) apps is now restricted to test or development Smile accounts. This change helps ensure that merchants are protected and the app ecosystem remains secure.List earning rules endpoint
The REST API now supports the ability to list earning rules. This endpoint can be used to display all the ways a customer can earn points.Customer VIP status object
The Customer object now includes a newvip_status property, which contains detailed information about a customer’s status within the VIP program. This endpoint can be used to display a customer’s progress towards the next VIP tier, when their VIP tier will expire, and much more!List reward fulfillments endpoint
The REST API now supports the ability to list reward fulfillments. This endpoint can be used to show customers a list of coupons they’ve previously redeemed for / what rewards they have available to use.List points transactions endpoint
The REST API now supports the ability to list points transactions. This endpoint can be used to show customers a history of how their points balance has changed over time, and results include both earning and redeeming activity.SmileUI.init() method deprecation
The SmileUI.init() method is now deprecated and should no longer be used by new installations. For information on how to migrate to the new SmileUI.initialize() method, refer to the migration guide.List VIP tiers endpoint
The REST API now supports the ability to list VIP tiers. This endpoint can be used to display a list of all available VIP tiers within a loyalty program, and the VIP Tier object has been updated to include nested objects for perks and entry rewards.Legacy Private Key deprecation
Using a Legacy Private Key to authenticate with the REST API is now deprecated. Please refer to the migration guide for more information on how to switch to using API keys instead.API key introduction
The REST API now supports authentication via API key. Each API key is assigned a specific set of access scopes during creation, and all endpoints now list the required access scope. This change enables easier rotation of API secrets, allows for more granular access control, and improves overall API security.April 7, 2025