Loyi API Reference
  1. Reward
Loyi API Reference
  • Getting Started
  • Architecture
  • User
    • Users Overview
    • Create user
      POST
    • Get users
      GET
    • Get user
      GET
    • Update user
      PUT
    • Delete user
      DELETE
  • Reward
    • Rewards Overview
    • Create reward
      POST
    • Get rewards
      GET
    • Delete reward
      DELETE
    • Create entry pass code
      POST
    • Get entry pass code
      GET
    • Airdrop reward
      PUT
    • Award reward
      POST
    • Redeem rewards
      GET
  • Collection
    • Collection Overview
    • Create collection
      POST
    • Get collections
      GET
    • Get collection
      GET
    • Update collection
      PUT
    • Delete collection
      DELETE
    • Get rewards
      GET
  • Collectible
    • Claim collectible
      POST
    • Get collectibles
      GET
  • Quest
    • Quest Overview
    • Create quest
    • Get quests
    • Get quest
    • Update quest
    • Delete quest
    • Get participants
    • Accept quest
    • Submit answers
    • Get answers
  • Leaderboard
    • Leaderboard Overview
    • Get leaderboard
  • Leveling
    • Get leveling configuration
    • Configure leveling
    • Get milestone levels
    • Create milestone level
    • Get milestone level
    • Update milestone level
    • Delete milestone level
  1. Reward

Rewards Overview

Rewards represent incentives given to users for completing quests or other achievements. They are the tangible benefits users earn through platform engagement.

Reward Types#

1.
CouponLinkUnique:
Contains multiple unique coupon codes
Each code can only be redeemed once
Requires a CSV file with line-seperated codes
2.
CouponLinkGeneric:
Single reusable coupon code
All users get the same code
Good for general discounts
3.
EntryPass:
Digital passes for events/venues
Includes expiration tracking
Scanner app: https://dashboard.loyi.io/public/scanner

Key Features#

Flexible Distribution: Can be airdropped to collections
Redemption Tracking: Monitor which users redeemed which rewards
Multi-format Support: Digital coupons, access passes, etc.
Verification System: Entry codes can be validated via API

Data Structures#

Endpoints#

MethodEndpointDescription
GET/rewardRetrieve all rewards
POST/rewardCreate new reward
DELETE/reward/{id}Delete reward
GET/reward/{id}/redeemRedeem already claimed reward
PUT/reward/{id}/airdropAirdrop reward to collection
POST/reward/entry-codeGenerate entry pass code
GET/reward/entry-code/{code}Validate entry code
Modified at 2025-03-27 15:48:29
Previous
Delete user
Next
Create reward
Built with