REST API v2
API references
Branding

Branding

Widget, referral, and reminder branding configuration

Get branding overview

GET/rest_api/v2/shop/branding

Returns all 3 branding types (widget, referral, reminder) in a single response. Useful for scanning the full branding configuration before making changes.

Authorizations
X-Joy-Loyalty-App-KeystringRequired
X-Joy-Loyalty-Secret-KeystringRequired
Responses
200All branding configurations
successbooleanOptional
Example: true
dataBrandingOverviewOptional

All branding types combined for quick overview scan.

Show properties
widgetWidgetBrandingOptional

Widget branding configuration (branding_point_v2). Maps to admin Storefront → Branding → Widget Design (4 tabs merged into flat object).

Show properties
primaryColorstringOptional

Primary widget color (hex)

Example: "#25272C"
secondaryColorstringOptional

Secondary widget color (hex)

Example: "#2F3136"
textColorstringOptional

Text color (hex)

Example: "#FFFFFF"
backgroundColorstringOptional

Background color (hex)

iconColorstringOptional

Icon color (hex)

buttonTextColorstringOptional

Button text color (hex)

Example: "#FFFFFF"
buttonBgColorstringOptional

Button background color (hex)

Example: "#25272C"
cornerRadiusnumberOptional

Corner radius in pixels

Example: 8
widgetIconstringOptional

Widget launcher icon

Example: "popup_crown"
widgetLabelstringOptional

Widget launcher label text

Example: "Rewards"
bannerTypestringOptional

Banner display type

Example: "default"
useMinimalButtonsbooleanOptional

Use minimal button style in widget

Example: true
floatBtnPositionstringOptional

Float button position on screen

Example: "left-bottom"
floatButtonLauncherstringOptional

Float button launcher style

Example: "icon_and_label"
floatBtnColorstringOptional

Float button color (hex)

Example: "#25272C"
floatBtnTextColorstringOptional

Float button text color (hex)

Example: "#FFFFFF"
themeTextFontstringOptional

Theme text font family

Example: "Inter"
headingTextFontstringOptional

Heading font family

Example: "Inter"
hideOnMobilebooleanOptional

Hide widget on mobile devices

Example: false
hideOnDesktopbooleanOptional

Hide widget on desktop

hideFloatBtnbooleanOptional

Hide the floating button entirely

Example: false
showOnlyLoggedInbooleanOptional

Show widget only to logged-in users

Example: false
autoShowPopupbooleanOptional

Auto-show popup when page loads

Example: false
showLowestTierFirstbooleanOptional

Show lowest VIP tier first in widget

Example: true
widgetPositionstringOptional

Widget popup position on screen

Example: "left-bottom"
referralReferralBrandingOptional

Referral popup branding configuration. Maps to admin Storefront → Branding → Referral.

Show properties
brandColorstringOptional

Primary referral color (hex)

Example: "#6366F1"
textColorstringOptional

Text color (hex)

Example: "#FFFFFF"
actionBgColorstringOptional

Action button background color (hex)

actionTextColorstringOptional

Action button text color (hex)

colorTypestringOptional

Color mode

Example: "template"
customSolidColorstringOptional

Custom solid color (hex)

themeTextFontstringOptional

Font family

Example: "Inter"
typeShowPopupstringOptional

Popup display type

isAutoClosePopUpbooleanOptional

Auto-close popup after delay

closingPopUpTimenumberOptional

Auto-close delay in seconds

Example: 10
frequencyShowPopupstringOptional

Display frequency

isShowSubscribeNewsletterbooleanOptional

Show newsletter subscribe checkbox

reminderReminderBrandingOptional

Proactive reminder branding configuration. Maps to admin Storefront → Branding → Reminder.

Show properties
showUnusedDiscountbooleanOptional

Show unused discount reminder

unusedDiscountHeadingstringOptional

Unused discount heading text

unusedDiscountButtonstringOptional

Unused discount button text

showRewardRedemptionbooleanOptional

Show reward redemption reminder

rewardRedemptionHeadingstringOptional

Reward redemption heading text

rewardRedemptionButtonstringOptional

Reward redemption button text

showMilestoneAchievedbooleanOptional

Show milestone achieved reminder

milestoneAchievedHeadingstringOptional

Milestone heading text

autoCloseAfternumberOptional

Auto-close delay in seconds

Example: 10
floatBtnPositionstringOptional

Reminder button position

reminderPrioritystring[]Optional

Reminder display order

metaobjectOptional

Additional metadata such as counts and pagination

messagestringOptional
Example: "Operation completed successfully"
timestampstring · date-timeOptional
Example: "2023-07-28T07:27:54.123Z"
GET/rest_api/v2/shop/branding
GET /rest_api/v2/shop/branding HTTP/1.1
Host: dev-api.joy.so
X-Joy-Loyalty-App-Key: YOUR_API_KEY
X-Joy-Loyalty-Secret-Key: YOUR_API_KEY
Accept: */*
200All branding configurations
{
  "success": true,
  "data": {
    "widget": {
      "primaryColor": "#25272C",
      "widgetPosition": "left-bottom",
      "widgetIcon": "popup_crown",
      "floatButtonLauncher": "icon_and_label",
      "hideOnMobile": false
    },
    "referral": {
      "brandColor": "#6366F1",
      "colorType": "template"
    },
    "reminder": {
      "showUnusedDiscount": true,
      "autoCloseAfter": 10
    }
  },
  "meta": {},
  "timestamp": "2026-03-24T10:00:00.000Z"
}

Get widget branding

GET/rest_api/v2/shop/branding/widget

Reads widget branding configuration (branding_point_v2). Maps to admin Storefront → Branding → Widget Design.

Authorizations
X-Joy-Loyalty-App-KeystringRequired
X-Joy-Loyalty-Secret-KeystringRequired
Responses
200Widget branding configuration
successbooleanOptional
Example: true
dataWidgetBrandingOptional

Widget branding configuration (branding_point_v2). Maps to admin Storefront → Branding → Widget Design (4 tabs merged into flat object).

Show properties
primaryColorstringOptional

Primary widget color (hex)

Example: "#25272C"
secondaryColorstringOptional

Secondary widget color (hex)

Example: "#2F3136"
textColorstringOptional

Text color (hex)

Example: "#FFFFFF"
backgroundColorstringOptional

Background color (hex)

iconColorstringOptional

Icon color (hex)

buttonTextColorstringOptional

Button text color (hex)

Example: "#FFFFFF"
buttonBgColorstringOptional

Button background color (hex)

Example: "#25272C"
cornerRadiusnumberOptional

Corner radius in pixels

Example: 8
widgetIconstringOptional

Widget launcher icon

Example: "popup_crown"
widgetLabelstringOptional

Widget launcher label text

Example: "Rewards"
bannerTypestringOptional

Banner display type

Example: "default"
useMinimalButtonsbooleanOptional

Use minimal button style in widget

Example: true
floatBtnPositionstringOptional

Float button position on screen

Example: "left-bottom"
floatButtonLauncherstringOptional

Float button launcher style

Example: "icon_and_label"
floatBtnColorstringOptional

Float button color (hex)

Example: "#25272C"
floatBtnTextColorstringOptional

Float button text color (hex)

Example: "#FFFFFF"
themeTextFontstringOptional

Theme text font family

Example: "Inter"
headingTextFontstringOptional

Heading font family

Example: "Inter"
hideOnMobilebooleanOptional

Hide widget on mobile devices

Example: false
hideOnDesktopbooleanOptional

Hide widget on desktop

hideFloatBtnbooleanOptional

Hide the floating button entirely

Example: false
showOnlyLoggedInbooleanOptional

Show widget only to logged-in users

Example: false
autoShowPopupbooleanOptional

Auto-show popup when page loads

Example: false
showLowestTierFirstbooleanOptional

Show lowest VIP tier first in widget

Example: true
widgetPositionstringOptional

Widget popup position on screen

Example: "left-bottom"
metaobjectOptional

Additional metadata such as counts and pagination

messagestringOptional
Example: "Operation completed successfully"
timestampstring · date-timeOptional
Example: "2023-07-28T07:27:54.123Z"
GET/rest_api/v2/shop/branding/widget
GET /rest_api/v2/shop/branding/widget HTTP/1.1
Host: dev-api.joy.so
X-Joy-Loyalty-App-Key: YOUR_API_KEY
X-Joy-Loyalty-Secret-Key: YOUR_API_KEY
Accept: */*
200Widget branding configuration
{
  "success": true,
  "data": {
    "primaryColor": "#25272C",
    "secondaryColor": "#2F3136",
    "textColor": "#FFFFFF",
    "backgroundColor": "string",
    "iconColor": "string",
    "buttonTextColor": "#FFFFFF",
    "buttonBgColor": "#25272C",
    "cornerRadius": 8,
    "widgetIcon": "popup_crown",
    "widgetLabel": "Rewards",
    "bannerType": "default",
    "useMinimalButtons": true,
    "floatBtnPosition": "left-bottom",
    "floatButtonLauncher": "icon_and_label",
    "floatBtnColor": "#25272C",
    "floatBtnTextColor": "#FFFFFF",
    "themeTextFont": "Inter",
    "headingTextFont": "Inter",
    "hideOnMobile": false,
    "hideOnDesktop": true,
    "hideFloatBtn": false,
    "showOnlyLoggedIn": false,
    "autoShowPopup": false,
    "showLowestTierFirst": true,
    "widgetPosition": "left-bottom"
  },
  "meta": {},
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}

Update widget branding

PUT/rest_api/v2/shop/branding/widget

Partial update — send only fields to change. Triggers metafield sync. Returns full widget branding state after update.

Authorizations
X-Joy-Loyalty-App-KeystringRequired
X-Joy-Loyalty-Secret-KeystringRequired
Request body
primaryColorstringOptional

Primary widget color (hex)

Example: "#25272C"
secondaryColorstringOptional

Secondary widget color (hex)

Example: "#2F3136"
textColorstringOptional

Text color (hex)

Example: "#FFFFFF"
backgroundColorstringOptional

Background color (hex)

iconColorstringOptional

Icon color (hex)

buttonTextColorstringOptional

Button text color (hex)

Example: "#FFFFFF"
buttonBgColorstringOptional

Button background color (hex)

Example: "#25272C"
cornerRadiusnumberOptional

Corner radius in pixels

Example: 8
widgetIconstringOptional

Widget launcher icon

Example: "popup_crown"
widgetLabelstringOptional

Widget launcher label text

Example: "Rewards"
bannerTypestringOptional

Banner display type

Example: "default"
useMinimalButtonsbooleanOptional

Use minimal button style in widget

Example: true
floatBtnPositionstringOptional

Float button position on screen

Example: "left-bottom"
floatButtonLauncherstringOptional

Float button launcher style

Example: "icon_and_label"
floatBtnColorstringOptional

Float button color (hex)

Example: "#25272C"
floatBtnTextColorstringOptional

Float button text color (hex)

Example: "#FFFFFF"
themeTextFontstringOptional

Theme text font family

Example: "Inter"
headingTextFontstringOptional

Heading font family

Example: "Inter"
hideOnMobilebooleanOptional

Hide widget on mobile devices

Example: false
hideOnDesktopbooleanOptional

Hide widget on desktop

hideFloatBtnbooleanOptional

Hide the floating button entirely

Example: false
showOnlyLoggedInbooleanOptional

Show widget only to logged-in users

Example: false
autoShowPopupbooleanOptional

Auto-show popup when page loads

Example: false
showLowestTierFirstbooleanOptional

Show lowest VIP tier first in widget

Example: true
widgetPositionstringOptional

Widget popup position on screen

Example: "left-bottom"
Responses
200Widget branding updated
successbooleanOptional
Example: true
dataWidgetBrandingOptional

Widget branding configuration (branding_point_v2). Maps to admin Storefront → Branding → Widget Design (4 tabs merged into flat object).

Show properties
primaryColorstringOptional

Primary widget color (hex)

Example: "#25272C"
secondaryColorstringOptional

Secondary widget color (hex)

Example: "#2F3136"
textColorstringOptional

Text color (hex)

Example: "#FFFFFF"
backgroundColorstringOptional

Background color (hex)

iconColorstringOptional

Icon color (hex)

buttonTextColorstringOptional

Button text color (hex)

Example: "#FFFFFF"
buttonBgColorstringOptional

Button background color (hex)

Example: "#25272C"
cornerRadiusnumberOptional

Corner radius in pixels

Example: 8
widgetIconstringOptional

Widget launcher icon

Example: "popup_crown"
widgetLabelstringOptional

Widget launcher label text

Example: "Rewards"
bannerTypestringOptional

Banner display type

Example: "default"
useMinimalButtonsbooleanOptional

Use minimal button style in widget

Example: true
floatBtnPositionstringOptional

Float button position on screen

Example: "left-bottom"
floatButtonLauncherstringOptional

Float button launcher style

Example: "icon_and_label"
floatBtnColorstringOptional

Float button color (hex)

Example: "#25272C"
floatBtnTextColorstringOptional

Float button text color (hex)

Example: "#FFFFFF"
themeTextFontstringOptional

Theme text font family

Example: "Inter"
headingTextFontstringOptional

Heading font family

Example: "Inter"
hideOnMobilebooleanOptional

Hide widget on mobile devices

Example: false
hideOnDesktopbooleanOptional

Hide widget on desktop

hideFloatBtnbooleanOptional

Hide the floating button entirely

Example: false
showOnlyLoggedInbooleanOptional

Show widget only to logged-in users

Example: false
autoShowPopupbooleanOptional

Auto-show popup when page loads

Example: false
showLowestTierFirstbooleanOptional

Show lowest VIP tier first in widget

Example: true
widgetPositionstringOptional

Widget popup position on screen

Example: "left-bottom"
metaobjectOptional

Additional metadata such as counts and pagination

messagestringOptional
Example: "Operation completed successfully"
timestampstring · date-timeOptional
Example: "2023-07-28T07:27:54.123Z"
400Validation error or no valid fields
successbooleanOptional
Example: false
errorobjectOptional
Show properties
messagestringOptional
Example: "Resource not found"
codestringOptional
Example: "NOT_FOUND"
statusCodeintegerOptional
Example: 404
detailsobjectOptional
timestampstring · date-timeOptional
Example: "2023-07-28T07:27:54.123Z"
PUT/rest_api/v2/shop/branding/widget
PUT /rest_api/v2/shop/branding/widget HTTP/1.1
Host: dev-api.joy.so
X-Joy-Loyalty-App-Key: YOUR_API_KEY
X-Joy-Loyalty-Secret-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 119


{
  "primaryColor": "#FF6B35",
  "buttonBgColor": "#FF6B35",
  "widgetPosition": "right-bottom",
  "cornerRadius": 12
}
200Widget branding updated
{
  "success": true,
  "data": {
    "primaryColor": "#25272C",
    "secondaryColor": "#2F3136",
    "textColor": "#FFFFFF",
    "backgroundColor": "string",
    "iconColor": "string",
    "buttonTextColor": "#FFFFFF",
    "buttonBgColor": "#25272C",
    "cornerRadius": 8,
    "widgetIcon": "popup_crown",
    "widgetLabel": "Rewards",
    "bannerType": "default",
    "useMinimalButtons": true,
    "floatBtnPosition": "left-bottom",
    "floatButtonLauncher": "icon_and_label",
    "floatBtnColor": "#25272C",
    "floatBtnTextColor": "#FFFFFF",
    "themeTextFont": "Inter",
    "headingTextFont": "Inter",
    "hideOnMobile": false,
    "hideOnDesktop": true,
    "hideFloatBtn": false,
    "showOnlyLoggedIn": false,
    "autoShowPopup": false,
    "showLowestTierFirst": true,
    "widgetPosition": "left-bottom"
  },
  "meta": {},
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}

Get referral branding

GET/rest_api/v2/shop/branding/referral

Reads referral popup branding configuration. Maps to admin Storefront → Branding → Referral.

Authorizations
X-Joy-Loyalty-App-KeystringRequired
X-Joy-Loyalty-Secret-KeystringRequired
Responses
200Referral branding configuration
successbooleanOptional
Example: true
dataReferralBrandingOptional

Referral popup branding configuration. Maps to admin Storefront → Branding → Referral.

Show properties
brandColorstringOptional

Primary referral color (hex)

Example: "#6366F1"
textColorstringOptional

Text color (hex)

Example: "#FFFFFF"
actionBgColorstringOptional

Action button background color (hex)

actionTextColorstringOptional

Action button text color (hex)

colorTypestringOptional

Color mode

Example: "template"
customSolidColorstringOptional

Custom solid color (hex)

themeTextFontstringOptional

Font family

Example: "Inter"
typeShowPopupstringOptional

Popup display type

isAutoClosePopUpbooleanOptional

Auto-close popup after delay

closingPopUpTimenumberOptional

Auto-close delay in seconds

Example: 10
frequencyShowPopupstringOptional

Display frequency

isShowSubscribeNewsletterbooleanOptional

Show newsletter subscribe checkbox

metaobjectOptional

Additional metadata such as counts and pagination

messagestringOptional
Example: "Operation completed successfully"
timestampstring · date-timeOptional
Example: "2023-07-28T07:27:54.123Z"
GET/rest_api/v2/shop/branding/referral
GET /rest_api/v2/shop/branding/referral HTTP/1.1
Host: dev-api.joy.so
X-Joy-Loyalty-App-Key: YOUR_API_KEY
X-Joy-Loyalty-Secret-Key: YOUR_API_KEY
Accept: */*
200Referral branding configuration
{
  "success": true,
  "data": {
    "brandColor": "#6366F1",
    "textColor": "#FFFFFF",
    "actionBgColor": "string",
    "actionTextColor": "string",
    "colorType": "template",
    "customSolidColor": "string",
    "themeTextFont": "Inter",
    "typeShowPopup": "string",
    "isAutoClosePopUp": true,
    "closingPopUpTime": 10,
    "frequencyShowPopup": "string",
    "isShowSubscribeNewsletter": true
  },
  "meta": {},
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}

Update referral branding

PUT/rest_api/v2/shop/branding/referral

Partial update for referral popup branding. Triggers metafield sync.

Authorizations
X-Joy-Loyalty-App-KeystringRequired
X-Joy-Loyalty-Secret-KeystringRequired
Request body
brandColorstringOptional

Primary referral color (hex)

Example: "#6366F1"
textColorstringOptional

Text color (hex)

Example: "#FFFFFF"
actionBgColorstringOptional

Action button background color (hex)

actionTextColorstringOptional

Action button text color (hex)

colorTypestringOptional

Color mode

Example: "template"
customSolidColorstringOptional

Custom solid color (hex)

themeTextFontstringOptional

Font family

Example: "Inter"
typeShowPopupstringOptional

Popup display type

isAutoClosePopUpbooleanOptional

Auto-close popup after delay

closingPopUpTimenumberOptional

Auto-close delay in seconds

Example: 10
frequencyShowPopupstringOptional

Display frequency

isShowSubscribeNewsletterbooleanOptional

Show newsletter subscribe checkbox

Responses
200Referral branding updated
successbooleanOptional
Example: true
dataReferralBrandingOptional

Referral popup branding configuration. Maps to admin Storefront → Branding → Referral.

Show properties
brandColorstringOptional

Primary referral color (hex)

Example: "#6366F1"
textColorstringOptional

Text color (hex)

Example: "#FFFFFF"
actionBgColorstringOptional

Action button background color (hex)

actionTextColorstringOptional

Action button text color (hex)

colorTypestringOptional

Color mode

Example: "template"
customSolidColorstringOptional

Custom solid color (hex)

themeTextFontstringOptional

Font family

Example: "Inter"
typeShowPopupstringOptional

Popup display type

isAutoClosePopUpbooleanOptional

Auto-close popup after delay

closingPopUpTimenumberOptional

Auto-close delay in seconds

Example: 10
frequencyShowPopupstringOptional

Display frequency

isShowSubscribeNewsletterbooleanOptional

Show newsletter subscribe checkbox

metaobjectOptional

Additional metadata such as counts and pagination

messagestringOptional
Example: "Operation completed successfully"
timestampstring · date-timeOptional
Example: "2023-07-28T07:27:54.123Z"
400Validation error or no valid fields
successbooleanOptional
Example: false
errorobjectOptional
Show properties
messagestringOptional
Example: "Resource not found"
codestringOptional
Example: "NOT_FOUND"
statusCodeintegerOptional
Example: 404
detailsobjectOptional
timestampstring · date-timeOptional
Example: "2023-07-28T07:27:54.123Z"
PUT/rest_api/v2/shop/branding/referral
PUT /rest_api/v2/shop/branding/referral HTTP/1.1
Host: dev-api.joy.so
X-Joy-Loyalty-App-Key: YOUR_API_KEY
X-Joy-Loyalty-Secret-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 147


{
  "brandColor": "#6366F1",
  "colorType": "custom-solid",
  "customSolidColor": "#6366F1",
  "isAutoClosePopUp": true,
  "closingPopUpTime": 10
}
200Referral branding updated
{
  "success": true,
  "data": {
    "brandColor": "#6366F1",
    "textColor": "#FFFFFF",
    "actionBgColor": "string",
    "actionTextColor": "string",
    "colorType": "template",
    "customSolidColor": "string",
    "themeTextFont": "Inter",
    "typeShowPopup": "string",
    "isAutoClosePopUp": true,
    "closingPopUpTime": 10,
    "frequencyShowPopup": "string",
    "isShowSubscribeNewsletter": true
  },
  "meta": {},
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}

Get reminder branding

GET/rest_api/v2/shop/branding/reminder

Reads proactive reminder branding configuration. Maps to admin Storefront → Branding → Reminder.

Authorizations
X-Joy-Loyalty-App-KeystringRequired
X-Joy-Loyalty-Secret-KeystringRequired
Responses
200Reminder branding configuration
successbooleanOptional
Example: true
dataReminderBrandingOptional

Proactive reminder branding configuration. Maps to admin Storefront → Branding → Reminder.

Show properties
showUnusedDiscountbooleanOptional

Show unused discount reminder

unusedDiscountHeadingstringOptional

Unused discount heading text

unusedDiscountButtonstringOptional

Unused discount button text

showRewardRedemptionbooleanOptional

Show reward redemption reminder

rewardRedemptionHeadingstringOptional

Reward redemption heading text

rewardRedemptionButtonstringOptional

Reward redemption button text

showMilestoneAchievedbooleanOptional

Show milestone achieved reminder

milestoneAchievedHeadingstringOptional

Milestone heading text

autoCloseAfternumberOptional

Auto-close delay in seconds

Example: 10
floatBtnPositionstringOptional

Reminder button position

reminderPrioritystring[]Optional

Reminder display order

metaobjectOptional

Additional metadata such as counts and pagination

messagestringOptional
Example: "Operation completed successfully"
timestampstring · date-timeOptional
Example: "2023-07-28T07:27:54.123Z"
GET/rest_api/v2/shop/branding/reminder
GET /rest_api/v2/shop/branding/reminder HTTP/1.1
Host: dev-api.joy.so
X-Joy-Loyalty-App-Key: YOUR_API_KEY
X-Joy-Loyalty-Secret-Key: YOUR_API_KEY
Accept: */*
200Reminder branding configuration
{
  "success": true,
  "data": {
    "showUnusedDiscount": true,
    "unusedDiscountHeading": "string",
    "unusedDiscountButton": "string",
    "showRewardRedemption": true,
    "rewardRedemptionHeading": "string",
    "rewardRedemptionButton": "string",
    "showMilestoneAchieved": true,
    "milestoneAchievedHeading": "string",
    "autoCloseAfter": 10,
    "floatBtnPosition": "left-bottom",
    "reminderPriority": [
      "string"
    ]
  },
  "meta": {},
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}

Update reminder branding

PUT/rest_api/v2/shop/branding/reminder

Partial update for proactive reminder branding. Triggers metafield sync.

Authorizations
X-Joy-Loyalty-App-KeystringRequired
X-Joy-Loyalty-Secret-KeystringRequired
Request body
showUnusedDiscountbooleanOptional

Show unused discount reminder

unusedDiscountHeadingstringOptional

Unused discount heading text

unusedDiscountButtonstringOptional

Unused discount button text

showRewardRedemptionbooleanOptional

Show reward redemption reminder

rewardRedemptionHeadingstringOptional

Reward redemption heading text

rewardRedemptionButtonstringOptional

Reward redemption button text

showMilestoneAchievedbooleanOptional

Show milestone achieved reminder

milestoneAchievedHeadingstringOptional

Milestone heading text

autoCloseAfternumberOptional

Auto-close delay in seconds

Example: 10
floatBtnPositionstringOptional

Reminder button position

reminderPrioritystring[]Optional

Reminder display order

Responses
200Reminder branding updated
successbooleanOptional
Example: true
dataReminderBrandingOptional

Proactive reminder branding configuration. Maps to admin Storefront → Branding → Reminder.

Show properties
showUnusedDiscountbooleanOptional

Show unused discount reminder

unusedDiscountHeadingstringOptional

Unused discount heading text

unusedDiscountButtonstringOptional

Unused discount button text

showRewardRedemptionbooleanOptional

Show reward redemption reminder

rewardRedemptionHeadingstringOptional

Reward redemption heading text

rewardRedemptionButtonstringOptional

Reward redemption button text

showMilestoneAchievedbooleanOptional

Show milestone achieved reminder

milestoneAchievedHeadingstringOptional

Milestone heading text

autoCloseAfternumberOptional

Auto-close delay in seconds

Example: 10
floatBtnPositionstringOptional

Reminder button position

reminderPrioritystring[]Optional

Reminder display order

metaobjectOptional

Additional metadata such as counts and pagination

messagestringOptional
Example: "Operation completed successfully"
timestampstring · date-timeOptional
Example: "2023-07-28T07:27:54.123Z"
400Validation error or no valid fields
successbooleanOptional
Example: false
errorobjectOptional
Show properties
messagestringOptional
Example: "Resource not found"
codestringOptional
Example: "NOT_FOUND"
statusCodeintegerOptional
Example: 404
detailsobjectOptional
timestampstring · date-timeOptional
Example: "2023-07-28T07:27:54.123Z"
PUT/rest_api/v2/shop/branding/reminder
PUT /rest_api/v2/shop/branding/reminder HTTP/1.1
Host: dev-api.joy.so
X-Joy-Loyalty-App-Key: YOUR_API_KEY
X-Joy-Loyalty-Secret-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56


{
  "showUnusedDiscount": true,
  "autoCloseAfter": 15
}
200Reminder branding updated
{
  "success": true,
  "data": {
    "showUnusedDiscount": true,
    "unusedDiscountHeading": "string",
    "unusedDiscountButton": "string",
    "showRewardRedemption": true,
    "rewardRedemptionHeading": "string",
    "rewardRedemptionButton": "string",
    "showMilestoneAchieved": true,
    "milestoneAchievedHeading": "string",
    "autoCloseAfter": 10,
    "floatBtnPosition": "left-bottom",
    "reminderPriority": [
      "string"
    ]
  },
  "meta": {},
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}
ShopTranslations
Product
Install AppWebsiteBook a Demo
Developers
JavaScript SDKREST API v2Webhook API
Company
Avada GroupHelp CenterContact
© 2026 Joy Loyalty by Avada Group. All rights reserved.