> ## Documentation Index
> Fetch the complete documentation index at: https://dev.smile.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Developer updates

> New releases and improvements for developers.

<Update label="June 9, 2026" tags={["JavaScript SDK"]}>
  ## Referral settings in the JavaScript SDK

  The JavaScript SDK now supports the ability to [get referral settings](/js/resources/referral-settings/get) and access [preloaded referral settings](/js/resources/referral-settings/preloaded). Use these methods to retrieve configuration information about the account's referral program, making it possible to display what customers can earn when they refer other individuals to the program.
</Update>

<Update label="April 27, 2026" tags={["JavaScript SDK", "Smile UI", "Deprecation"]}>
  ## Smile UI method deprecations

  An official sunset date for the `Smile.*` methods bundled with Smile UI has been set for August 1, 2026. On this date, these methods will be removed from the Smile UI library and will exclusively be available as part of the JavaScript SDK.

  Please migrate to the new JavaScript SDK as soon as possible to avoid any potential issues. Refer to the [migration guide](/guides/use-cases/custom-frontend/js-sdk-migration) for instructions and details on exactly what's changing and how to update your code.
</Update>

<Update label="March 26, 2026" tags={["JavaScript SDK"]}>
  ## VIP tiers in the JavaScript SDK

  The JavaScript SDK now supports the ability to [get VIP tiers](/js/resources/vip-tiers/get), [get a single VIP tier by ID](/js/resources/vip-tiers/get-by-id), and access [preloaded VIP tiers](/js/resources/vip-tiers/preloaded). Each [VIP tier object](/js/resources/vip-tiers/object) includes nested entry rewards, making it easy to display tier details and benefits in custom-built UIs.
</Update>

<Update label="March 18, 2026" tags={["JavaScript SDK"]}>
  ## Earning rules in the JavaScript SDK

  The JavaScript SDK now supports the ability to [get earning rules](/js/resources/earning-rules/get) and access [preloaded earning rules](/js/resources/earning-rules/preloaded). Use these methods to display the ways customers can earn points in custom-built UIs and interfaces.
</Update>

<Update label="March 13, 2026" tags={["REST API"]}>
  ## Get points settings endpoint

  The REST API now supports the ability to [get points settings](/api/resources/points-settings/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").
</Update>

<Update label="February 9, 2026" tags={["JavaScript SDK", "Smile UI", "Deprecation"]}>
  ## 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](/js/including). 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](/js/introduction) 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 the `Smile` 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()`

  Refer to the individual method pages in the documentation for specific instructions on migrating.
</Update>

<Update label="February 2, 2026" tags={["REST API"]}>
  ## Create activities using a customer's email address

  The [create an activity](/api/resources/activities/create-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).
</Update>

<Update label="January 31, 2026" tags={["REST API", "Deprecation"]}>
  ## 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.
</Update>

<Update label="December 11, 2025" tags={["Apps"]}>
  ## 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.
</Update>

<Update label="September 23, 2025" tags={["REST API"]}>
  ## List earning rules endpoint

  The REST API now supports the ability to [list earning rules](/api/resources/earning-rules/list-earning-rules). This endpoint can be used to display all the ways a customer can earn points.
</Update>

<Update label="September 15, 2025" tags={["REST API"]}>
  ## Customer VIP status object

  The [Customer object](/api/resources/customers/customer-object) now includes a new `vip_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!
</Update>

<Update label="August 8, 2025" tags={["REST API"]}>
  ## List reward fulfillments endpoint

  The REST API now supports the ability to [list reward fulfillments](/api/resources/reward-fulfillments/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.
</Update>

<Update label="July 31, 2025" tags={["REST API"]}>
  ## List points transactions endpoint

  The REST API now supports the ability to [list points transactions](/api/resources/points-transactions/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.
</Update>

<Update label="July 24, 2025" tags={["Smile UI", "Deprecation"]}>
  ## `SmileUI.init()` method deprecation

  The `SmileUI.init()` method is now deprecated and should no longer be used by new installations. Use the new [`SmileUI.initialize()` method](/ui/initializing) instead.
</Update>

<Update label="July 24, 2025" tags={["Smile UI"]}>
  ## `SmileUI.initialize()` method introduction

  Smile UI has a new way of performing initialization: the `SmileUI.initialize()` [method](/ui/initializing). This method is more secure and flexible than the previous `SmileUI.init()` method, and is now the recommended way to initialize Smile UI.
</Update>

<Update label="July 7, 2025" tags={["REST API"]}>
  ## List VIP tiers endpoint

  The REST API now supports the ability to [list VIP tiers](/api/resources/vip-tiers/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](/api/resources/vip-tiers/vip-tier-object) has been updated to include nested objects for perks and entry rewards.
</Update>

<Update label="May 8, 2025" tags={["REST API", "Deprecation"]}>
  ## Legacy Private Key deprecation

  Using a Legacy Private Key to authenticate with the REST API is now deprecated. Please refer to the [migration guide](https://help.smile.io/en/articles/11730614-migrate-from-a-legacy-private-key-to-api-keys) for more information on how to switch to using API keys instead.
</Update>

<Update label="May 8, 2025" tags={["REST API"]}>
  ## 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.
</Update>

<Update label="April 7, 2025">
  ## Merchant technical contacts

  Merchants can now specify a technical contact within Smile Admin on the **Settings** > **[Developer Tools](https://app.smile.io/settings/developer-tools)** page. This contact will be notified via email whenever there are important API updates or security alerts related to their account.
</Update>