Update user spin-wheel information

When to use this

01Authentication#

Header

Authorization: Bearer <API_KEY>

Permission

customerSuccessShown in the dashboard as “Customer Success”

Use a Community API key with customerSuccess, shown in the dashboard as Customer Success, and keep it on your server. The key decides the community, so gameId must be a wheel in that community.

02Behaviour#

03Request#

Headers#

Body#

Send email, gameId, and at least one pair: spin_op with spin, streak_op with streak, or both pairs. The pairs are independent: you can add spins and overwrite the streak in the same call. Values of 0 are allowed, so overwrite with 0 clears spins or the streak.

The email lookup isn't limited to your community: an email that belongs to someone outside it still updates that person's state on your wheel. Confirm the trader with Get User Data first.

curl --request POST \
  --url https://api.returning.ai/v1/mini-game-logs/update-wheel-info \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "trader@example.com",
    "gameId": "66f000000000000000000702",
    "spin_op": "add",
    "spin": 1,
    "streak_op": "overwrite",
    "streak": 3
  }'

04Response#

A 200 means the changes are saved. data.spinResult and data.streakResult appear only for what you sent. This endpoint has no top-level code; branch on the HTTP status.

{
  "status": "success",
  "message": "Updated wheel info for trader@example.com",
  "data": {
    "miniGameId": "66f000000000000000000702",
    "gameName": "Daily Spin the Wheel",
    "spinResult": "Added 1 spin(s). 0 -> 1",
    "streakResult": "Streak updated. 0 -> 3"
  }
}

05Errors#

{
  "meta": {
    "status": "error",
    "statusCode": 400
  },
  "message": "Update user wheel info endpoint validation error.",
  "detail": {
    "spin_op": "Invalid enum value. Expected 'overwrite' | 'add' | 'subtract', received 'multiply'"
  },
  "solution": "Check your body in request and try again"
}

06Next step#