OPoptimove
Leaderboards

Enroll a Player in a Tournament

Enrollment applies to tournament-type leaderboards only. Calling this on a regular leaderboard returns 400 "Only tournaments require enrollment".

If costAmount is non-null in the response, re-fetch GET /player-rewards/brand/{brandId}/player/{playerId} so the player's balance reflects the entry fee.

post/leaderboards/{brandId}/{leaderboardId}/enroll/{playerId}

Request

  • Base URL
    https://opti-ls-api-us.optimove.net/api
  • URL
    https://opti-ls-api-us.optimove.net/api/leaderboards/{brandId}/{leaderboardId}/enroll/{playerId}
  • Auth
    none declared

Path parameters

brandIdstring uuid required
Example:aebb6a6a-bdef-480f-8096-e13f9c3d4969

Brand UUID returned by GET /brands/default/{tenantId}.

leaderboardIdstring required
Example:lb-11111111-1111-1111-1111-111111111111

Leaderboard UUID (from the leaderboards list id).

playerIdstring required
Example:player-123

Your internal player/customer identifier.

Response

Player is enrolled.

leaderboardIdstring
playerIdstring
isEnrolledboolean
enrolledAtstring date-time nullable
costCurrencyIdstring uuid nullable
costAmountinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.