Update Customer Activation
Opt a customer in or out of the loyalty program, mirroring the dashboard include/exclude toggle.
PUT
Set a customer’s loyalty program participation state (active/inactive). This mirrors the include/exclude toggle in the Gameball dashboard — use it on your storefront so customers can control participation, or manage participation from your backend.
The endpoint is idempotent:
- Opting out an already opted-out customer produces no side effects.
- Opting in an already opted-in customer produces no side effects.
- A state set via API is immediately reflected in the dashboard toggle, and vice versa.
- Gameball is the source of truth for participation status.
isActive: false):
- No points are earned from events or purchases.
- No rewards or coupons are generated.
- No earnings, redemptions, or reward activity occurs.
- The customer is excluded from all campaign eligibility.
Security: Provide
apikey header. secretkey is required on v4.1; on v4.0 required when High Security Mode is enabled.Idempotency
Calling the endpoint twice with the same customer and state always succeeds. On the first call that changes state,stateChanged is true. On a repeat call with the same state, stateChanged is false — no database writes, no side effects, no notifications.
Errors
Notes and limitations
- There is no batch endpoint — manage multiple customers with sequential or parallel individual requests (respect rate limits).
- Changes take effect immediately for future earnings; assume a small propagation delay in edge cases.
- State changes are logged in your Gameball audit trail.
- This endpoint only sets participation. To modify other customer attributes, use Create Customer or the other customer management endpoints.
Path Parameters
Body
application/json
Response
Customer activation state updated (or already in the requested state)