Skip to content
RallyHere Docs

Get Key Claims For Me

Deprecated
GET
/inventory/v1/player/me/keyClaim

Get All Key Claims for all external Key campaigns for the current player.

Authorizations

Responses

200

Successful Response

List of Key Claims available to the player.

object
claims
required

List of Key Claims available to the Player

Array<object>

A KeyClaim is a reward a player for fulfilling requirements of an eternal marketing campaign. Once the player has completed the requirements of the campaign and have been assigned a sku of the campaign by the Platform, invoke Process Key Entitlements to consume the sku from the Platform for a Key Claim.

object
portal_id

Platform the player is on

integer
portal_user_id

The Platform’s unique identifier for the player

string
key_claim_uuid
required

The unique identifier for the KeyClaim

string format: uuid
claimed

Whether the KeyClaim has been claimed

boolean
external_key

The external key that was been claimed by the player. This is only filled out once the KeyClaim has been claimed

string
external_key_campaign_uuid

The unique identifier for the MarketingCampaign that the external key was claimed from

string format: uuid
external_key_type

This can be used to allow the player to claim different types based on their preferrence. While we don’t have requirement for what should contain, it must match a key type assigned to the external campaign.

string
created_on

The time the KeyClaim was created

string
last_modified_on

The time the KeyClaim was last modified

string

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

409

Conflict

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

500

Internal Server Error

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string