LogoLogo
HomepageCase studiesBook a demo
User Guide
User Guide
  • Welcome to Open Loyalty!
  • What's New
    • 2024
    • 2023
    • 2022
  • What's Next
  • Technical Guide
  • Main Features
    • Global Management
      • Analytics
      • Settings
      • Config Duplication
      • Usage
    • Dashboard
      • General Overview
      • Units Wallet Overview
      • Additional Metrics
      • Members by Tiers
    • Members
      • Member List
        • Configuration
        • Creating Members
        • Managing Members
        • Removing Members
      • Segments
        • Creating Segments
        • Managing Segments
        • Segment Conditions
      • Referred Members
    • Campaigns
      • Creating Campaigns
        • Return Campaign
        • Referral Campaign
        • Time-Based Campaign
        • Redemption Code Campaign
        • Internal event - Achievement progressed
        • Percent value distribution
      • Managing Campaigns
      • Campaign Simulation
      • Follow-up Campaigns
    • Custom Events
      • Custom Event Schemas
    • Transactions
      • Adding Transactions
      • Managing Transactions
      • Channels
    • Tiers
      • Adding Tiers
      • Managing Tiers
      • Tiers Configuration
      • Tier Benefits
    • Wallets
      • Wallet Types and Configuration
      • Unit Transfers
        • Creating Unit Transfers
        • Importing Unit Transfers
        • Managing Unit Transfers
    • Achievements
      • Creating Achievement
      • Managing Achievements
      • Follow up Achievements
    • Rewards
      • Reward List
        • Rewards Configuration
        • Creating Reward
        • Reward Types
        • Units Conversion Coupon
        • Adding Coupons
        • Reward Flow
      • Reward Fulfillment
      • Reward Categories
    • Webhooks
      • How to Configure a Webhook
      • What Triggers a Webhook
      • Expiring Notifications
    • Collections
    • Imports / Exports
      • Imports
        • Sample Import Files
      • Exports
        • UI Data Exports
        • Configuration Exports
        • S3 Bucket Exports
    • Settings
      • Roles
      • Admins
        • System Logs
      • Tenants
      • Translations
    • Expressions
      • Attributes List
      • Operators
      • Custom Functions
      • Expression Examples
      • Sample Use Cases
        • Using Member Custom Attributes
        • Complex Effects (if, else)
        • Excluding Members
        • Elapsed Time Conditions
        • Using Additional Dates for Calculations
        • Register on Birthday
        • Transaction on Birthday
        • Tier Upgrade or Downgrade
  • Sample Setups
    • Good Practices
    • Pay with Points
    • Promo and Discounts in Cart
    • Sample Campaigns
      • #1 Earn 1 point for every $1 spent
      • #2 Earn 2x points when shopping on Monday morning
      • #3 Earn 1 stamp for every transaction
      • #4 Buy product ACME 123 and earn 100 points
      • #5 Refer a friend and get 100 points
      • #6 Refer 5 friends and get a $50 off coupon for the next purchase
      • #7 Register to the program and get 50 bonus points
      • #8 Get 30 bonus points for your first transaction in the loyalty program
      • #9 Cashback campaign
      • #10 Product meets selected criteria
    • Sample Achievements
      • #1 Celebrate summer - Buy 5 times between June and August
      • #2 Place 10 Orders above 50€ - Complete 10 transactions, for more than 50€ each
      • #3 Ambitious player - Log in to the game 3 times per week for 8 consecutive weeks
      • #4 SKU 'ABC' configuration - Spend total of 100$ on products with SKU 'ABC132' in September
      • #5 Workout track -Track a workout of at least 30 minutes for 5 days in a row
      • #6 4 referees made the transactions for 2 consecutive weeks
      • #7 2 referees made a transaction configuration
  • FAQ
    • Configuration Migration
    • Custom Attributes
    • Achievements
    • GDPR
    • Opt-Out
    • Referral Programs
    • Returns and Cancellations
Powered by GitBook
On this page

Was this helpful?

  1. FAQ

Opt-Out

How to Allow Users to Opt-Out from the Loyalty Program

Last updated 11 months ago

Was this helpful?

As an administrator, you need to provide users with clear and easy options to opt-out of the loyalty program when they wish to do so. This guide outlines the three methods available for users to opt-out, along with the necessary API calls to implement these actions.

1. Deactivation

Description: Deactivation allows users to temporarily leave the loyalty program while retaining the option to reactivate their account in the future. This is useful for users who may wish to take a break from the program but keep their accumulated points and rewards intact.

Implementation Steps:

  1. User Interface:

    • Ensure the option to deactivate is available in the user's account settings.

    • Provide clear instructions and confirmation prompts to avoid accidental deactivations.

  2. API Call:


2. Anonymization

Description: Anonymization allows users to opt-out by removing all personally identifiable information (PII) from the system. However, loyalty data is retained for analytical purposes. This method ensures that users' privacy is protected while allowing the program to maintain valuable data for insights.

Implementation Steps:

  1. User Interface:

    • Provide an anonymization option in the user's account settings.

    • Clearly explain that this action is irreversible and requires re-registration for future participation.

  2. API Call:


3. Deletion

Description: Deletion permanently removes all data associated with a user's account, including both PII and loyalty data. This method is irreversible and is intended for users who wish to completely exit the program with no data retention.

Implementation Steps:

  1. User Interface:

    • Include a deletion option in the user's account settings.

    • Ensure users understand that this action will permanently delete all their data and cannot be undone.

  2. API Call:


Best Practices for Implementation

  • User Communication: Clearly communicate the implications of each opt-out method to users. Use confirmation dialogs and detailed descriptions to ensure users make informed decisions.

  • User Experience: Make the opt-out process user-friendly and easily accessible within the account settings.

  • Data Security: Ensure that all API calls and data handling comply with relevant data protection regulations, such as GDPR.

  • Support: Provide support contact information for users who may have questions or need assistance with the opt-out process.

Conclusion

By implementing these three opt-out methods, you can provide users with flexible options to manage their participation in the loyalty program. Whether they choose to temporarily deactivate, anonymize their data, or permanently delete their account, ensuring a clear and secure process enhances user trust and satisfaction.

Please refer to our for more information.

Please refer to our for more information.

Please refer to our for more information.

For further details on the APIs and additional configurations, refer to the . If you need further assistance, please contact our support team.

API Docs
API Docs
API Docs
Open Loyalty API Documentation

Deactivate a member

post

Management This method allows deactivating a specific Member account.

Authorizations
Path parameters
memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+
storeCodestringRequired

Store code

Responses
204
Success. No content.
400
Bad request.
application/json
403
Forbidden.
application/json
404
Not found.
application/json
post
POST /api/{storeCode}/member/{member}/deactivate HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Accept: */*

No content

Anonymize member’s data

post

Management This method allows anonymizing a specific member account.

Authorizations
Path parameters
memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+
storeCodestringRequired

Store code

Responses
204
Success. No content.
400
Bad request.
application/json
404
Not found.
application/json
post
POST /api/{storeCode}/member/{member}/anonymize HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Accept: */*

No content

Delete a member

delete

Management This method allows removing a specific Member account.

Authorizations
Path parameters
memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+
storeCodestringRequired

Store code

Responses
204
Success. No content.
401
Unauthorized.
application/json
403
Forbidden.
application/json
404
Not found.
application/json
delete
DELETE /api/{storeCode}/member/{member} HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Accept: */*

No content

  • 1. Deactivation
  • POSTDeactivate a member
  • 2. Anonymization
  • POSTAnonymize member’s data
  • 3. Deletion
  • DELETEDelete a member
  • Best Practices for Implementation