Opt-Out

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

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:

Deactivate a member

<label style="background-color: #D4EDBC;padding:5px;">Management</label><br><br> This method allows deactivating a specific Member account.

post

/api/{storeCode}/member/{member}/deactivate

Authorizations

Bearertoken

Path parameters

memberstringrequired

Pattern: [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

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://openloyalty.localhost/api/{storeCode}/member/{member}/deactivate' \
  --header 'Authorization: YOUR_API_KEY'

204

400

403

404

204

No body

Success. No content.

Please refer to our API Docs for more information.

---

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:

Anonymize member’s data

<label style="background-color: #D4EDBC;padding:5px;">Management</label><br><br> This method allows anonymizing a specific member account.

post

/api/{storeCode}/member/{member}/anonymize

Authorizations

Bearertoken

Path parameters

memberstringrequired

Pattern: [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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://openloyalty.localhost/api/{storeCode}/member/{member}/anonymize' \
  --header 'Authorization: YOUR_API_KEY'

204

400

404

204

No body

Success. No content.

Please refer to our API Docs for more information.

---

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:

Delete a member

<label style="background-color: #D4EDBC;padding:5px;">Management</label><br><br> This method allows removing a specific Member account.

delete

/api/{storeCode}/member/{member}

Authorizations

Bearertoken

Path parameters

memberstringrequired

Pattern: [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

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://openloyalty.localhost/api/{storeCode}/member/{member}' \
  --header 'Authorization: YOUR_API_KEY'

204

401

403

404

204

No body

Success. No content.

Please refer to our API Docs for more information.

---

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.

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