1. Streaks & Mini Games
Returning.AI
  • Getting Started
  • Bulk Operations
    • Bulk user updates
    • List bulk update jobs
      GET
    • Get bulk update job status
      GET
    • Get bulk update job details
      GET
    • Bulk update users from CSV
      POST
    • Bulk update premium currency from CSV
      POST
  • Chart Analysis
    • Create Analysis
      POST
    • Get Analysis
      GET
    • Update Analysis
      PATCH
    • Delete Analysis
      DELETE
    • List Analyses
      GET
    • Append Drawings
      POST
  • Rewards & Redemptions
    • Redemption lifecycle
    • Store catalog to redemptions
    • Update redemption order status or refund
    • List redemption orders by user email
    • List redemption statuses
    • Get redemption status by ID
    • List redemption orders by community
    • Create redemption order status
    • Get redemption order status history
    • List redemption orders by custom-field identifier
  • Gamification
    • Leaderboards
      • Leaderboards
      • List leaderboards with pagination
      • Create a new leaderboard
      • Update an existing leaderboard
      • Get a single leaderboard by ID
      • Delete a leaderboard
    • Streaks & Mini Games
      • Mini-game State and History
      • List user streak logs
        GET
      • List mini-game logs by user email
        POST
      • Get current mini-game and streak state
        POST
      • Update user spin-wheel information
        POST
    • Referral
      • Referral Program Integration
      • Get referral programs
      • Get user's referral summary
    • Rolling Data
    • Match Predictions
      • Create match prediction
      • List match predictions
      • Get match prediction
      • Patch match prediction
      • Publish match prediction
      • Settle match prediction
      • Get settlement results
      • Void match prediction
      • Bulk update match predictions
      • Get bulk job status
      • Get bulk job results
    • Loyalty Points
      • Create loyalty points export
      • Get loyalty points export status
      • Get loyalty points export download link
    • Quizzes
      • Create quiz
      • List quizzes
      • Get quiz
      • Update quiz
      • Delete quiz
      • Add quiz question
      • Update quiz question
      • Delete quiz question
    • Get tier configuration
      GET
    • Get daily user XP and coin changes
      POST
    • Search user gamification logs
      POST
    • Get user activity stats
      POST
  • Messaging
    • Agent messaging workflow
    • Get Messages
    • Send Message
    • Reply Message
    • React Message
    • Upload message images
  • Users
    • User directory and provisioning
    • Get Users with Filters
    • Create New User
    • Get User Data
    • Manage User Account
    • Get User Milestones
    • Update User Data, Identifier, And Roles
  • Channels
    • Iframe
    • List integration channels
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
    • Channels
    • Leaderboard
    • Milestone
    • Socials
    • Store
  • Community Analytics
    • Get Loyalty Overview
    • Get Phone Verification Contacts
  • Store
    • Store journey
    • Store catalog
    • Purchase History
      • Archive or restore an order
      • Update redemption instructions or voucher details
    • Categories
      • List Store categories
      • Create Store category
      • Get Store category by ID
      • Update Store category
      • Delete Store category
    • Products
      • List products
      • Create products in bulk
      • Create product with vouchers
      • Update products in bulk
      • Read product
      • Update product and append vouchers
      • Delete product
    • Redemption-transaction
      • Get redemption transaction detail
    • Get Store configuration
    • Update Store configuration
  • Community
    • Community directory and appearance
    • Appearance
      • Update community theme colors
      • Update community bot profile
      • Update community URL metadata
      • Update community name and URL
    • Community Users
      • Get community users
      • Get user
    • Create community
  • User Fields
    • User field definitions and history
    • User Field History
      • List Community User-Field History
      • List One Field Across Users
      • List One User Across Fields
      • List One User's One Field
      • Update A User Field Value
      • Deprecated Field-First History Write
      • Deprecated Field-First History Read
    • Create A User Field Definition
    • Get A User Field Definition
    • Update A User Field Definition
    • Delete A User Field Definition
    • List User Field Definitions
  • API Keys
    • API key lifecycle
    • Community API Keys
      • Create API key
      • Read API keys
      • Delete API key
      • Update API key
    • User API Keys
      • List user API keys
      • Create user API key
      • Update user API key
      • Delete user API key
      • Get current API key information
  • Legacy
    • Servers
      • Create server
      • List servers
      • Update server metadata
    • Bulk Operations
      • Bulk import users from CSV
    • Authentication
      • Register user with password
      • Verify user email
      • Log in user with password
      • Secure Auth
    • Badges
      • List badges
      • Create badge
      • Update badge
      • Delete badge
      • Remove badge from user
      • Award badge to user
    • Messaging
    • Roles & Permissions
      • List server roles
      • Create role
      • Update role
      • Delete role
      • List user roles
      • Add role to user
      • Remove role from user
    • Users
      • Get user
      • Upload user avatar
    • Channels
      • Create channel
      • Update channel
      • Delete channel
    • API Keys
      • List integration API keys
      • Create integration API key
      • Delete integration API key
      • Update integration API key
  • Community Logs
    • Retrieve and export community logs
  1. Streaks & Mini Games

Update user spin-wheel information

POST
https://sgtr-integration.returning.ai/apis/v1/mini-game-logs/update-wheel-info
Gamification/Streaks & Mini Games

What this endpoint does#

Adds, subtracts, or overwrites a member's spin count and streak for one spin-wheel game. Use it only after approval.
Read current state and logs first. After a correction, read state again.
INFO
Safer path
POST /v1/users/mini-game-streak-stats and POST /v1/mini-game-logs/by-email first. Send all six required fields only when a correction is approved.

Quick start#

Required fields: gameId, email, spin_op, spin, streak_op, streak. Operators: overwrite, add, subtract.

Authentication and permission#

Send Authorization: Bearer <COMMUNITY_API_KEY>. Intended permission is customerSuccess. Keep the key server-side.

Complete examples#

Send the six required fields together. An incomplete body can return HTML 500 instead of JSON 400. Stop if the gateway returns HTML.
Treat emails and game ids as synthetic.
A successful mutation body is still unproven. A disposable member's current-state read returned wheels: [], so this pass had no gameId to send. Do not invent the 200 envelope.

Success and readback#

After an approved mutation:
1.
POST /v1/users/mini-game-streak-stats with the same email.
2.
POST /v1/mini-game-logs/by-email and look for admin-updated if that action is present.
CHECK
HTML 500
If the gateway returns HTML, stop. Do not loop the call.

Errors and recovery#

StatusWhenRecovery
HTML 500Incomplete required setStop. Send all six fields only after approval.
401Missing or invalid Bearer tokenAdd a valid community key.

Retry safety#

WARNING
Exact retry
This mutates spin inventory and streak counters. Do not retry timeouts or 500 without reading current state first. Duplicate add calls change balances again. There is no idempotency key.

Gotchas#

Use /v1/mini-game-logs/update-wheel-info.
Read APIs do not replace this write. They are the verification path.
spin_op and streak_op are independent.

Next steps#

Mini-game state and history
Read current counters and logs before and after any approved correction.

Request

Body Params application/json

Examples

Responses

🟢200OK
application/json
Request completed successfully.
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://sgtr-integration.returning.ai/apis/v1/mini-game-logs/update-wheel-info' \
--header 'Content-Type: application/json' \
--data-raw '{
    "gameId": "<gameId>",
    "email": "member@example.com",
    "spin_op": "add",
    "spin": 2,
    "streak_op": "overwrite",
    "streak": 10
}'
Response Response Example
200 - Example 1
{}
Modified at 2026-08-19 18:38:16
Previous
Get current mini-game and streak state
Next
Referral Program Integration
Built with