Skip to main content
POST

Headers

x-publisher-token
string

Publisher token.

signature
string

The signed payload.

Body

application/json
playerId
string

Player ID (the same value as the publisherPlayerId property returned in the Authenticate Player Callback).

Response

200 - application/json

Successful operation

status
enum<string>
required

Web store personalization request status.

Available options:
valid,
invalid
Example:

"valid"

sessionMetadata
object
required

Container for storing any pertinent information related to the player's session. If enabled, this is sent back in the Grant Award Callback as well.

version
integer

The used version. In this case, the value is ‘2’

Example:

2

Logo ID provided when a file is uploaded to the Assets Library. Use this to display a logo in your web store.

Example:

"MY_LOGO_ASSET_ID"

profileFrameId
string

Corresponds to the profile frame picture ID uploaded to the asset library in Appcharge's dashboard. Displayed above the player's profile picture.

Example:

"profileFrame123"

playerLevelName
string

Aligns with the player level picture name/ID uploaded to the asset library in Appcharge's dashboard. Displayed alongside the footer.

Example:

"playerLevelName"

bannerExternalId
string

Aligns with the banner asset ID uploaded to the asset library in Appcharge’s dashboard. Displayed at the top of the screen.

Example:

"playerLevelAssetId"

playerLevel
object

Presents discounts related to the player’s level.

playerLevelBanners
object[]

List of banners to display to players based on their game level.

offersOrder
enum<string>
default:priceLowToHigh

Defines the order of offers.

Available options:
publisherOrder,
priceHighToLow,
priceLowToHigh
sectionsOrder
string[]

An array of publisher’s section ids that defines the order of sections for the store.

segments
string[]

The list of segments associated with the player.

focus
object

Customize which offer you want to focus on.

attributes
object

A set of custom key-value pairs that you can define to tag players for segmentation and A/B testing. These attributes can then be used to filter players in the Publisher Dashboard.

Example: { "BF_test": "test", "monetization_persona": "non_payer" }

storeTheme
object

Information about the web store theme.

balances
object[]

A list of product balances of the player.

offers
object[]