August 2026
New Endpoints
- GET /v3/bonus-rules - Returns a list of bonus rules matching the provided search criteria. Requires api:bonus-rule:read entitlement.
- GET /v3/bonus-rules/{code} - Returns a single bonus rule by its code. Requires api:bonus-rule:read entitlement.
- POST /v3/bonus-rules - Creates a new bonus rule. Requires api:bonus-rule:modify entitlement.
- PUT /v3/bonus-rules/{code} - Updates a bonus rule. Requires api:bonus-rule:modify entitlement.
- PATCH /v3/bonus-rules/{code} - Updates a live (published) bonus rule. Requires api:bonus-rule:modify or the new api:bonus-rule:admin entitlement.
- DELETE /v3/bonus-rules/{code} - Deletes a bonus rule. Requires api:bonus-rule:modify entitlement.
- GET /v3/promotion-rules - Returns a list of promotion rules matching the provided search criteria. Requires api:promotion-rule:read entitlement.
- GET /v3/promotion-rules/{code} - Returns a single promotion rule by its code. Requires api:promotion-rule:read entitlement.
- POST /v3/promotion-rules - Creates a new promotion rule. Requires api:promotion-rule:modify entitlement.
- PUT /v3/promotion-rules/{code} - Updates a promotion rule. Requires api:promotion-rule:modify entitlement.
- PATCH /v3/promotion-rules/{code} - Updates a live (published) promotion rule. Requires api:promotion-rule:modify or the new api:promotion-rule:admin entitlement.
- DELETE /v3/promotion-rules/{code} - Deletes a promotion rule. Requires api:promotion-rule:modify entitlement.
- GET /v3/users - Returns a list of active users (userId and displayName) with pagination support, default page size 500. Requires api:user:read entitlement.
New Entitlements
- api:bonus-rule:admin - New entitlement granting full admin access to bonus rules, including the ability to edit all fields of a published bonus rule.
- api:promotion-rule:admin - New entitlement granting full admin access to promotion rules, including the ability to edit all fields of a published promotion rule.
New Fields on Existing Endpoints
- Segment definition (create/update/get) - Added memberCurrenciesNeverExpire boolean field. When true, currencies for members in this segment will not expire.
- RedemptionRule schema - Added displayOnline boolean field (default true) to indicate whether a redemption rule should be displayed in online contexts.
Renamed Schemas
- Promotion renamed to PromotionReward
- BonusRule renamed to BonusReward
- BonusRuleAdmin renamed to BonusRule
Deprecated and Removed Paths
Semicolon-style matrix parameters have been replaced with standard query parameters and path IDs across several endpoints.
Old path | New path |
|---|---|
GET /v3/members/{memberIdentifier}/transactions/referenceId;{referenceId} | GET /v3/members/{memberIdentifier}/transactions?referenceId={referenceId} |
GET /v3/members/{memberIdentifier}/transaction-groups/transactionGroupReferenceId;{transactionGroupReferenceId} | GET /v3/members/{memberIdentifier}/transaction-groups?transactionGroupReferenceId={transactionGroupReferenceId} |
DELETE /v3/members/{memberIdentifier}/transaction-groups/transactionGroupReferenceId;{transactionGroupReferenceId}/cancel | POST /v3/members/{memberIdentifier}/transaction-groups/{transactionGroupId}/cancel NOTE: method changed from DELETE to POST, and the path now uses transactionGroupId rather than transactionGroupReferenceId |
GET /v3/custom-data/{customDataId}/details;externalKey={externalKey} | GET /v3/custom-data/{customDataId}/details?externalKey={externalKey} |
PUT /v3/custom-data/{customDataId}/details;externalKey={externalKey} | PUT /v3/custom-data/{customDataId}/details?externalKey={externalKey} |