Sign in

3b11e1670d61

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-107844420.7 KB
Customers

Update Customer Activation

Set a customer's loyalty program participation state (active/inactive). This mirrors the include/exclude toggle in the Gameball dashboard.

The endpoint is idempotent: opting out an already opted-out customer (or opting in an already opted-in customer) produces no side effects. stateChanged indicates whether the state actually changed.

When a customer is opted out (isActive: false): no points are earned from events or purchases, no rewards or coupons are generated, and the customer is excluded from all campaign eligibility. Prior activity is not undone.

Security: Requires apiKey header. secretKey is required on v4.1; on v4.0 required when High Security Mode is enabled.

Requires an existing customer. Unknown customers return 404 Not Found.

put/api/v4.0/integrations/customers/{customerId}/activate

Path parameters

customerIdstring required

The customer's unique external identifier in your system.

Request body

isActiveboolean required

Set to true to opt the customer in (Include); set to false to opt the customer out (Exclude).

Response

Customer activation state updated (or already in the requested state)

customerIdstring

Echo of the customer ID from the request.

isActiveboolean

The customer's activation state after this request.

stateChangedboolean

true if the state was different before this request and changed as a result; false if the customer was already in the target state (idempotent no-op).

Example response

{
  "customerId": "cust-12345",
  "stateChanged": true
}