Loyalty Management Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Loyalty Management Standard Objects
Loyalty Management Fields on Standard Objects
Coupon Objects in Loyalty Management
Loyalty Management Associated Objects
Apex Reference
Loyalty Management Business APIs
REST Reference
Resources
Request Bodies
Response Bodies
Additional Attributes Output
Additional Transaction Journal Attributes Output
Badge Output
Club Member Benefits
Club Member Details
Club Member Enrollment Details
Club Member Promotions
Club Membership Renewal
Corporate Member Enrollment Output
Coupon Availablity Message
Coupon Usage Result
Clone Promotion Output
Credit Points Action Output
Debit Points Action Output
Eligible Promotions List
Eligible Loyalty Tiers Output
Events Detail Output
Expression
Expression Value
Game Assignment Output
Game Details
Game Result
Game Reward Details
Game Rewards List
Games List
Issue Voucher Action Output
Individual Member Enrollment Output
Loyalty Account Output
Loyalty Engine Realtime Output
Loyalty Contact Output
Loyalty Process Output
Loyalty Program Process Rule
Loyalty Program Process Rule Step
Loyalty Program Process Rule Action
Loyalty Program Process Rule Action Parameter
Loyalty Program Process Rule Condition
Loyalty Program Process Rule Condition Filter Criteria
Loyalty Program Process Rule Condition Group
Loyalty View Transaction Journal History Output
Member Benefits Output
Member Benefit Output
Member Currency Output
Member Currency Change
Member Engagement Trail Output
Member Engagement Attribute
Member Points Balance
Member Profile Output
Member Currency
Member Tier Output
Member Points Balance Change
Name And Id Output
Participant Game Rewards List
Process Result
Points Change Output
Points Summary
Product Details
Promotion Configuration Output
Promotion Coupon Availability
Promotion Coupon
Promotion Details
Promotion Eligibility Output
Promotion Eligible Channel Output
Promotion Eligible Enrollment Period Output
Promotion Details
Promotion Limit
Promotion Limit Output
Promotion Recommendations
Promotion Reward Details
Promotion Rules List
Recommendation Details
Redeem Voucher Output
Summary
Transaction Details Output
Transaction Journal Output
Transaction Journal Map Output
Transaction Journal Result
Transaction Journal Process Result
Transaction Ledgers Output
Update Cumulative Usage Action Output
Unified Promotions Output
Voucher
Vouchers List
Voucher Result
Voucher Output
Loyalty Management Connect API Interchangeable Request Fields
Loyalty Management Standard Invocable Actions
Loyalty Management Custom Invocable Actions
Loyalty Management Metadata API Types
Loyalty Management Tooling API Objects
Loyalty Management Mobile SDK
Gamification Mobile SDK
Data Processing Engine, Batch Management, and Monitor Workflow Services
PDF

Member Engagement Trail Output

Output representation of member engagement trail API.
Sample Response

The field remainingResetCount and totalResetCount may show null if the set limit is 1.

Note

{
  "memberEngagementAttributeOutputRepresentations": [
    {
      "attributeStatus": "Active",
      "currentValue": null,
      "defaultValue": "0",
      "description": null,
      "endDate": "2025-01-31",
      "name": "Book A Cab",
      "startDate": "2024-11-01",
      "targetValue": "2.0"
    },
    {
      "attributeStatus": "Active",
      "currentValue": null,
      "defaultValue": "0",
      "description": null,
      "endDate": "2025-01-31",
      "name": "Book A Hotel Room",
      "startDate": "2024-11-01",
      "targetValue": "1.0"
    },
    {
      "attributeStatus": "Active",
      "currentValue": null,
      "defaultValue": "0",
      "description": null,
      "endDate": "2025-01-31",
      "name": "Book A Flight",
      "startDate": "2024-11-01",
      "targetValue": "1.0"
    }
  ],
  "message": null,
  "promotionName": "Engagement Trail",
  "remainingResetCount": null,
  "rewards": [
    {
      "badgeReward": [],
      "pointsRewards": [
        {
          "currencyName": "Reward Points",
          "points": 200
        },
        {
          "currencyName": "Tier Points",
          "points": 100
        }
      ],
      "voucherRewards": []
    }
  ],
  "status": true,
  "totalResetCount": null
}
Property Name Type Description Filter Group and Version Available Version
status Boolean Indicates whether the request succeeded (true) or failed (false). Small, 62.0 62.0
message String The message explaining why the request failed. Small, 62.0 62.0
engagementAttribute Indicates the event that is tracked for a member. Small, 62.0 62.0
totalResetCount Integer The maximum number of times a member can complete the engagement trail and earn rewards. Small, 62.0 62.0
remainingResetCount Integer The number of times a member can still complete the engagement trail and earn rewards. Small, 62.0 62.0