Loyalty Admin API
EnumCustomerMark1
A enum representing a mark that can be applied on a customer.
A mark is a predefined label with special meaning in Bubblehouse. Unlike shop tags, which can be arbitrary strings, you can only apply the marks listed here.
Marks apply when you set them through this API, or when the customer has a shop tag from that mark’s configured tag list in settings. An empty list means shop tags do not apply the mark. Matching a shop tag to the mark’s API name by coincidence is not enough.
remove_customer_mark clears a stored API mark. It does not turn off a mark that only comes from a shop tag list; change the tag or the list instead.
Please contact the Bubblehouse team and explain your use case before using these.
| Kind | Enum type |
|---|---|
| Used in | AdjustCustomerState3 |
Values
-
testerThe customer is a tester.
This excludes this customer from statistics, enables additional tester-only actions, and relaxes certain checks to allow dangerous actions to be easily performed on the customer.
-
readonlyPrevents the customer from making any changes to their loyalty state.
This puts the customer in read-only mode, disallowing any actions that would change their loyalty program state.
-
disable_rewardsExcludes the customer from the loyalty program entirely.
Marks the customer as ineligible for the loyalty program (wholesale customers would be an appropriate example). This disables the entire loyalty program and any and all rewards.
Generally, you want to apply this mark via customer tags. An ability to override the mark for specific customers is provided for special cases.
-
enable_rewardsMarks the customer eligible for the loyalty program, even if they would otherwise be excluded based on their tags
This gives an ability to override the state for specific customers in special cases.
-
disable_earning_rewardsDisables earning of any additional rewards.
Disables the earning part of the loyalty program, but allows the customer to spend any rewards they already have.
-
disable_spending_rewardsDisables spending of rewards.
Disallows any use or spending of the rewards, but allows the customer to continue to earn more rewards.
-
high_riskMarks a suspicious or high-risk account.
Lowers thresholds on internal fraud detection systems, and asks customer support to be especially careful about them.
Generally, you want to apply this mark via customer tags. An ability to override the mark for specific customers is provided for special cases.
-
disable_referralsDisallows sending of referrals.
Should generally be applied to people spamming referrals indiscriminately. Disallows sending any further referrals, and disallows any further rewards to be earned from the referrals.
-
reject_referralsAuto-reject further referrals sent.
Doesn't prevent the customer from sending further referrals or from using the rewards they have already obtained from referrals, but automatically rejects them as ineligible.
-
disable_tiersDisable the tiers part of the loyalty program.
Prevents the customer from entering a tier, and removes any tier they might already hold. Note that even base tier rewards, if any, won't be available to the customer.
-
disable_votingDisable the voting part of the loyalty program.
Meant for customers abusing the voting system or spamming useless responses.
-
insiderMarks a customer as insider (generally an employee or similar).
Some programs have special treatment of insider customers.
Generally, you want to apply this mark via customer tags. An ability to override the mark for specific customers is provided for special cases.
-
trustedMarks a high-trust customer account.
This prevents fraud detection from triggering in most situations, including IP and address matching checks for referrals.
Generally, you want to apply this mark via customer tags. An ability to override the mark for specific customers is provided for special cases.