Personalized Rates on
All Platforms

Personalized Rates

Personalized Rates lets Button Publishers retrieve dynamic, promotional rates/offers to targeted users with little to no configuration required. Rates can be adjusted on-the-fly based on user segment and Merchant promotions, without the need for Button Publishers to manually update their CMS to provide new rates to users.

Merchants can create campaigns that target specific cohorts of users and products with different rates. Publishers will receive the rates as soon as they are live within Button and present the new rates to users in real-time.

Product Diagram

In this guide, we'll go over:

  1. Key benefits
  2. Getting rates for a user
  3. An example

Note: To get started with Personalized Rates, contact your Button Partner Success Manager today.


Key Benefits

  • Unlock more revenue opportunities by serving higher rates to valuable user segments
  • Personalize offers for each of your users based on their eligibility
  • Access the best rates in real-time from your Merchant partners
  • Boost user engagement by giving your users what they want—the best possible offers


Side by Side Comparison


Getting Rates for a User

Personalized Rates is a server-side API integration. Upon a user opening the app, the Publisher should call the Personalized Rates API with the user's Publisher user ID and at least one other user identifier (we accept hashed email and device ID). Button will use the identifiers to determine offers the user is eligible for with partnered Merchants, and return the full list of eligible rates/offers. These rates/offers may depend on the audiences the Merchant wants to target, and negotiated rates between the Publisher and Merchant.

You can find your API key here in the Dashboard.

The Personalized Rates API accepts the following parameters when requesting rates/offers:

  • user_id: Publisher’s ID for the user.
  • device_ids: (optional) List of devices IDs associated with the user.
  • email_sha256s: (optional) List of SHA256 email hashes associated with the user.
  • merchant_id: (optional) Merchant organization ID to restrict user offers to.

Note: Either device_ids or email_sha256s must be present in the request.


Example

For a user with the following identifiers

curl --basic -u <YOUR_API_KEY>: 'https://api.usebutton.com/v1/offers' \
  --data-raw '{
  "user_id": "1234",
  "device_ids": ["AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA"],
  "email_sha256s": ["1234567a1234567a1234567a1234567a1234567a1234567a1234567a1234567a"]
}'

The Publisher might receive a response like the below:

{
  "meta": {
    "status": "ok"
  },
  "object": {
    "merchant_offers": [
      {
        "merchant_id": "org-merchant-1",
        "best_offer_id": "offer-001-2",
        "offers": [
          {
            "id": "offer-001-0",
            "rate_percent": "5",
            "display_params": {
              "category": "Sports"
            }
          },
          {
            "id": "offer-001-1",
            "rate_percent": "5",
            "display_params": {
              "category": "Outdoors"
            }
          },
          {
            "id": "offer-001-2",
            "rate_percent": "10",
            "display_params": {
              "category": "Baby Products"
            }
          },
          {
            "id": "offer-001-13",
            "rate_percent": "2"
          }
        ]
      },
      {
        "merchant_id": "org-merchant-2",
        "best_offer_id": "offer-002-0",
        "offers": [
          {
            "id": "offer-002-0",
            "rate_percent": "6"
          }
        ]
      }
    ]
  }
}

This offer response means that if this user purchases from org-merchant-1, the Publisher will receive 5% back on Sports and Outdoors, 10% on Baby Products, and 2% on other items. If the user purchases from org-merchant-2, the Publisher will receive 6% back on all items. The display_params field of the offer can be used to fill in to your existing templates for the Merchant to show to the user in a card or banner. Button can also, by request, provide assets to present the offers. The full API documentation can be found here.

Note: The offers do not currently include the user reward or terms and exclusions. It is the Publisher's responsibility to present these to the user.