API Reference

Claim a Level Reward

post
https://opti-ls-api-us.optimove.net/api/levels/brand//player//configs//levels//claim

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

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

string
required

Your internal player/customer identifier.

uuid
required

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

integer
required
≥ 1

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

Responses
200

Reward claimed. Empty body.

Updated 1 day ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago