Sign in

v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB
Levels

Claim a Level Reward

Grants the rewards attached to a level the player has reached but not yet claimed. The list of claimable levels is surfaced in the claimableLevels array of the Player level response; render a per-entry "Claim" button.

After a successful claim, re-fetch the player level data (the entry drops out of claimableLevels) and GET /player-rewards/brand/{brandId}/player/{playerId} so the player's balance reflects the new rewards.

post/levels/brand/{brandId}/player/{playerId}/configs/{levelConfigId}/levels/{levelNumber}/claim

Path parameters

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

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

playerIdstring required
Example:player-123

Your internal player/customer identifier.

levelConfigIdstring uuid required
Example:f0e1d2c3-b4a5-6789-0abc-def012345678

UUID of the level configuration the level belongs to. Pull from the per-config endpoint getAllPlayerLevels (levelConfigId field on each tier).

levelNumberinteger required
Example:2

The level being claimed. Pass claimableLevels[].levelNumber from the Player level response.

Response

Reward claimed. Empty body.