Overview
What's New
Web Store
- Player Authentication
- Offers
- Personalization
- Webhooks
Checkout
- Checkout Session
- Orders
- Finance and Analytics
- Checkout Webhooks
Events Center
- Introduction
- Login Events
- Store Interaction Events
- Error Events
- Order Events
- Refund and Dispute Events
Personalization
Personalization API
POST
/
curl --request POST \
--url https://{publisher-server}/{personalization-endpoint}/ \
--header 'Content-Type: application/json' \
--data '{
"playerId": "<string>"
}'
{
"version": 2,
"status": "valid",
"sessionMetadata": {},
"profileFrameId": "profileFrame123",
"playerLevelName": "playerLevelName",
"bannerExternalId": "playerLevelAssetId",
"playerLevel": {
"assetId": "playerLevel1",
"text": "10%",
"endsIn": 1728283121000
},
"playerLevelBanners": [
{
"assetId": "<string>",
"designId": "<string>",
"text": [
{
"id": "<string>",
"content": "<string>"
}
],
"endsIn": 123
}
],
"offersOrder": "priceLowToHigh",
"sectionsOrder": [
"<string>"
],
"segments": [
"<string>"
],
"focus": {
"publisherBundleId": "bundle123"
},
"balances": [
{
"publisherProductId": "product123",
"quantity": 5
}
],
"offers": [
{
"publisherOfferId": "offer123",
"offerDesignOverride": {
"offerDesignSubtitleTextOverride": "<string>",
"offerDesignId": "<string>"
},
"productSale": {
"amountBeforeSale": 123,
"sale": 123,
"type": 123
},
"priceDiscount": {
"priceBeforeDiscount": 100,
"discount": 20,
"type": "percentage"
},
"badges": [
{
"publisherBadgeId": "badge123",
"position": "center",
"ribbonTextOverride": "<string>"
}
],
"dynamicOfferUi": {
"badges": [
{
"publisherBadgeId": "badge123",
"position": "center",
"ribbonTextOverride": "<string>"
}
],
"salePercentage": 123,
"amountBeforeSale": 123,
"salePercentageDisplayType": "<string>",
"offerDesignId": "<string>"
},
"productsSequence": [
{
"index": 123,
"productSale": {
"amountBeforeSale": 123,
"sale": 123,
"type": 123
},
"priceDiscount": {
"priceBeforeDiscount": 100,
"discount": 20,
"type": "percentage"
},
"badges": [
{
"publisherBadgeId": "badge123",
"position": "center",
"ribbonTextOverride": "<string>"
}
],
"products": [
{
"publisherProductId": "product123",
"quantity": 2,
"priority": "Main",
"rarityProductInfo": {
"stars": 5,
"tooltip": [
{
"sectionName": "Special Offers",
"products": [
{
"publisherProductId": "Coin",
"text": "20%"
}
]
}
]
}
}
]
}
]
}
]
}
Note: You can read more about Personalization (formerly Player Info Sync) in the Guides section.
Headers
The publisher token
Body
application/json
Response
200 - application/json
Successful operation
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://{publisher-server}/{personalization-endpoint}/ \
--header 'Content-Type: application/json' \
--data '{
"playerId": "<string>"
}'
{
"version": 2,
"status": "valid",
"sessionMetadata": {},
"profileFrameId": "profileFrame123",
"playerLevelName": "playerLevelName",
"bannerExternalId": "playerLevelAssetId",
"playerLevel": {
"assetId": "playerLevel1",
"text": "10%",
"endsIn": 1728283121000
},
"playerLevelBanners": [
{
"assetId": "<string>",
"designId": "<string>",
"text": [
{
"id": "<string>",
"content": "<string>"
}
],
"endsIn": 123
}
],
"offersOrder": "priceLowToHigh",
"sectionsOrder": [
"<string>"
],
"segments": [
"<string>"
],
"focus": {
"publisherBundleId": "bundle123"
},
"balances": [
{
"publisherProductId": "product123",
"quantity": 5
}
],
"offers": [
{
"publisherOfferId": "offer123",
"offerDesignOverride": {
"offerDesignSubtitleTextOverride": "<string>",
"offerDesignId": "<string>"
},
"productSale": {
"amountBeforeSale": 123,
"sale": 123,
"type": 123
},
"priceDiscount": {
"priceBeforeDiscount": 100,
"discount": 20,
"type": "percentage"
},
"badges": [
{
"publisherBadgeId": "badge123",
"position": "center",
"ribbonTextOverride": "<string>"
}
],
"dynamicOfferUi": {
"badges": [
{
"publisherBadgeId": "badge123",
"position": "center",
"ribbonTextOverride": "<string>"
}
],
"salePercentage": 123,
"amountBeforeSale": 123,
"salePercentageDisplayType": "<string>",
"offerDesignId": "<string>"
},
"productsSequence": [
{
"index": 123,
"productSale": {
"amountBeforeSale": 123,
"sale": 123,
"type": 123
},
"priceDiscount": {
"priceBeforeDiscount": 100,
"discount": 20,
"type": "percentage"
},
"badges": [
{
"publisherBadgeId": "badge123",
"position": "center",
"ribbonTextOverride": "<string>"
}
],
"products": [
{
"publisherProductId": "product123",
"quantity": 2,
"priority": "Main",
"rarityProductInfo": {
"stars": 5,
"tooltip": [
{
"sectionName": "Special Offers",
"products": [
{
"publisherProductId": "Coin",
"text": "20%"
}
]
}
]
}
}
]
}
]
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.