Loyalty
The Loyalty console at/marketing/loyalty runs your standing membership program: you define how members earn points and which tiers they climb, and the console tracks every member’s balance with the actions to adjust or redeem it. The marketing hub overview positions this console against the other three; the Loyalty program guide designs earn rules, tiers, and the redemption flow; the concept page defines the model underneath.
Loyalty is a tenant-owned control. Points exist only because you defined the rules that mint them: until you configure a program, no member accrues anything.
What you see on the page
The console stacks the program definition above the member table. Program header. The program name with its current revision, plus the earn rules (for example Per $1 on theorder_paid event) and the tier ladder with each tier’s threshold and benefits. The header carries three controls: Edit program (or Customize program before you have touched the default), Reset program, and the member-level actions below.
Members table. One row per member in the program:
Who can read and who can act
The dashboard gates the whole console at the workspace level; the API splits reads from writes at the scope level:
A credential that clears the read scope but not the write scope can list balances and receives a
403 on program, adjust, and redeem writes.
Worked examples
Adjust a member balance with a reason
- Find the member in the table and choose Adjust.
- Pick a credit or a debit, enter the points, and write the reason, for example
goodwill — delayed order. - Confirm. The available and lifetime figures move accordingly, and the reason is kept with the adjustment.
Redeem points through the incentives engine
- Choose Redeem on the member’s row.
- Enter the points to burn. The dialog blocks overspend: you cannot redeem more than the Available figure.
- Confirm. The balance drops, and the redemption posts to the Incentives ledger as a record you can audit like any other reward.
Set the program up against a wallet pass
Define at least one earn rule and a base tier at threshold 0 (the program form requires both), then issue loyalty cards from the Wallet Passes console. Members accrue on the pass, and a balance update bumps the pass’s generation counter so holder devices refresh without a re-save.API pairing
The console’s program editor writesPOST /api/v1/loyalty/program:
revision_id the program now reports. The full field lists live in the Loyalty API reference — treat it as the contract for anything beyond the envelope above. The console’s Adjust and Redeem dialogs write the adjust and redeem endpoints of the same surface.