Customer

The Customer API can be used to create, update and display customers' information as well as attach/detach tags in Gameball. Customers are uniquely identified by playerUniqueId.

Available Endpoints

Type

Description

Endpoint

POST

/integrations/player

GET

/integrations/player/{playerUnqiueId}

GET

/integrations/player/{playerUnqiueIdl}/balance

GET

/integrations/player/{playerUnqiueId}

/hash

GET

/integrations/player/{playerUnqiueIdl}/progress

DELETE

/integrations/player/{playerUnqiueId}

GET

/integrations/player/{playerUnqiueIdl}/progress/challenge/{handle}

GET

/integrations/transactions/{playerUniqueId}/coupon

GET

/integrations/players/{playerUniqueId}/referrals

GET

/integrations/players/referrals

POST

/integrations/player/{playerUnqiueId}/tags

DELETE

/integrations/player/{playerUnqiueId}/tags

POST - Create Customer

https://api.gameball.co/api/v3.0/integrations/player

The API call is used to create or update a customer in Gameball with the provided attributes.

This endpoint could also be used in case of referral. In such case,referralCode of the referring customer is to be provided along with the body parameters. So that Gameball understands that the newly created customer is being referred.

mobile or email should be sent along with the playerUniqueId in case (only if) your account supports channel merging.

In cases where channel merging is supported, you have the flexibility to identify users by their mobile number or email. For accounts utilizing separate systems for online and offline channels, it's advisable to consider changing the customer's unique ID to either their mobile number or email address for enhanced efficiency.

Request

Attribute

Type

Required

Description

APIKey

string

Yes

Client API key

Body

Attribute

Type

Required

Description

playerUniqueId

string

Yes

Unique identifier for the customer in your database.

Could be database ID, random string, email or anything that uniquely identifies the customer.

mobile

string

No

Customer's unique mobile number. (Sent in case your account supports channel merging)

email

string

No

Customer's unique email. (Sent in case your account supports channel merging)

playerAttributes

object

No

An object with set of properties that you want to set for the customer. This object also includes a customobject inside for custom attributes.

referrerCode

string

No

Referring customer’s referral code. This is used in case of referral, where the customer to be created is referred by the customer having this code.

levelOrder

integer

No

The VIP tier order to place the customer in.

IMPORTANT: manual customer VIP tiering is available under special circumstances and is not available by default. Contact us for more info.

deviceToken

string

No

The FCM token (Firebase Cloud Messaging) needed for sending mobile push notifications. (Used only in case of mobile app)

osType

string

No*

OS Type according to the mobile device used (if any). Note: Required in case deviceToken is sent in the payload (e.g. "android", "ios")

playerAttributes Object

Parameter

Type

Description

displayName

string

Customer's display name.

firstName

string

Customer's first name.

lastName

string

Customer's last name.

mobile

string

Customer's mobile number.

gender

string

Customer's gender. Example: M or F, Male or Female.

email

string

Customer's email.

dateOfBirth

string

Customer's date of birth.

Example: "1980-09-19T00:00:00.000Z"

joinDate

string

Customer join date at your system.

Example: "2019-09-19T21:06:29.158Z"

tags

string

Comma separated string of tags to be attached to the customer.

Example: "VIP,Platinum"

country

string

Country of the customer.

city

string

City of the customer.

zip

string

ZIP of the customer.

totalSpent

float

Total amount spent by customer.

totalOrders

int

Total orders by customer.

lastOrderDate

date

Last order date.

avgOrderAmount

float

Average order amount.

custom

object

Key value pairs of any extra player attributes.

{"class" : "E2022", "weight" : 78}

{
   "playerUniqueId":"player123",
   "mobile": "+1234567", // optional (Channel Merging)
   "email": "jon.snow@example.com", // optional (Channel Merging)
   "playerAttributes":{
      "displayName":"Jon Snow",
      "firstName": "Jon",
      "lastName": "Snow",
      "mobile": "+1234567",
      "email":"jon.snow@example.com",
      "gender":"M",
      "dateOfBirth":"1980-09-19T00:00:00.000Z",
      "joinDate":"2019-09-19T21:06:29.158Z",
       "country": "Egypt",
        "city": "Cairo",
        "zip": "18754",
      "tags": "VIP,Platinum",
      "custom":{
          "location":"Miami",
          "graduationDate":"2018-07-04T21:06:29.158Z",
          "isMarried":false
      }
    },
    "referrerCode": null,
    "levelOrder": null
  }

Response

Parameter

Type

Description

playerUniqueId

string

Unique identifier for the customer at Gameball Note: in case your account supports channel merging, mobile or email could be used instead of playerUniqueId.

gameballId

string

Customer's ID at Gameball.

levelsProgress

int

The current progress of customer on the VIP tier.

level

object

VIP tier object holds information about the customer's current VIP tier at Gameball.

balance

object

An object that contains all the information about the customer's balance.

referralCode

string

Customer's Referral Code. Used to refer another customer.

referralLink

string

Referral URL.

dynamicReferralLink

string

Referral URL for mobile APPs integrations with firebase.

Sample Response

{
    "playerUniqueId": "player123",
    "gameballId": 160281869,
    "levelsProgress": 0,
    "level": {
        "id": 17812,
        "name": "very Basic ",
        "description": "",
        "levelStartScore": 0,
        "levelOrder": 1,
        "iconPath": "https://cdn.gameball.co/uploads/gb-library/levels-icons/level-a1.png",
        "benefits": {
            "scoreEnteryReward": 0,
            "pointsEnteryReward": 0,
            "levelDiscount": null,
            "discountCapping": null
        }
    },
    "balance": {
        "pointsBalance": 0,
        "pointsValue": 0.0,
        "pendingPoints": 0,
        "pendingPointsValue": 0.0,
        "currency": "USD",
        "walletPointsName": "Points",
        "totalPositivePoints": 0,
        "totalPositivePendingPoints": 0,
        "totalNegativePoints": 0,
        "totalNegativePendingPoints": 0
    },
    "referralCode": "QQAF9B02734oKn",
    "referralLink": "https://wizardtest123.myshopify.com/account/register?ReferralCode=QQAF9B02734oKn",
    "dynamicReferralLink": null
}

Usage Examples

Example One

This example creates a new customer at Gameball, using playerUniqueId, playerAttributes with custom attributes.

curl -X POST -H 'apiKey: 807b041b7d35425988e354e1f6bce186' -d '{
  "playerUniqueId":"player123",
  "mobile": "+1234567",
  "email": "jon.snow@example.com",
  "playerAttributes":{
      "displayName":"Jon Snow",
      "firstName": "Jon",
      "lastName": "Snow",
      "mobile": "+1234567",
      "email":"jon.snow@example.com",
      "gender":"M",
      "dateOfBirth":"1980-09-19T00:00:00.000Z",
      "joinDate":"2019-09-19T21:06:29.158Z",
      "country": "Egypt",
        "city": "Cairo",
        "zip": "18754",
      "custom":{
         "location":"Miami",
         "graduationDate":"2018-07-04T21:06:29.158Z",
         "isMarried":false
      }
   }

  }' -v -i 'https://api.gameball.co/api/v3.0/integrations/player'

Example Two

This example is a request sent to Gameball when customer with referralCodeβ€œCODE11” successfully refers a new customer with playerUniqueId β€œplayer456”. Customer attributes are also sent within the same request.β€Œ

Note: All attributes inside the playerAttributes object are optional, if the values of any attributes shown below are unavailable, remove the attribute from the playerAttributes object.

curl -X POST -H 'apiKey: 807b041b7d35425988e354e1f6bce186' -d '{
   "referrerCode":"CODE11",
   "playerUniqueId":"player456",
   "playerAttributes":{
      "displayName":" Tyrion Lannister",
      "firstName":"Tyrion",
      "lastName":"Lannister",
      "email":"tyrion@example.com",
      "gender":"M",
      "dateOfBirth":"1978-01-11T00:00:00.000Z",
      "joinDate":"2019-09-19T21:06:29.158Z",
      "custom":{
         "location":"Miami",
         "graduationDate":"2018-07-04T21:06:29.158Z",
         "isMarried":false
  	}
   }
  }' -v -i 'https://api.gameball.co/api/v3.0/integrations/player'

GET - Retrieve Customer

This API call is used to retrieve customer's information.

https://api.gameball.co/api/v3.0/integrations/player/{playerUnqiueId}

mobile or email should replace playerUniqueId in case (only if) your account supports channel merging.

Request

Header

Attribute

Type

Required

Description

APIKey

string

Yes

Client APIKey

Lang

string

No

Language to get the customer info with. If not provided, the response would be in default language.

Note: The language provided should be as per configured languages in your account.

Example: "en", "fr".

Path Parameters

Parameter

Type

Required

Description

playerUniqueId

string

Yes

Unique identifier for the customer at Gameball. Note: in case your account supports channel merging, mobile or email could be used instead of playerUniqueId

Response

Parameter

Type

Description

playerUniqueId

string

Unique identifier for the customer at Gameball.

playerAttributes

object

An object with set of customer properties defined previously at the customer's creation.

referralCode

string

Customer's Referral Code. Used to refer another customer.

referralLink

string

Referral URL.

dynamicReferralLink

string

Referral URL for mobile APPs integrations with firebase.

level

object

Level object holds information about the customer's current VIP tier at Gameball.

levelsProgress

int

The current progress of the customer on the VIP tier.

points

object

The current balance of the customer.

Level Object

The Level object contains info about the customer's current VIP tier.

Parameter

Type

Description

name

string

VIP tier Name.

description

string

VIP tier Description.

levelOrder

integer

VIP tier Order.

iconPath

string

Logo icon of the VIP tier.

benefits

object

An object contains the benefits of the current VIP tier of the specified customer.

The benefits object is described as follows:

  • scoreEntryReward: Rewarded score on entering the current VIP tier.

  • pointsEntryReward: Rewarded points on entering the current VIP tier.

  • levelDiscount: Discount rewarded to the customer on entering the current VIP tier.

  • discountCapping: Maximum order total price that allows the discount to be applied.

Sample Response

{
   "playerUniqueId":"player456",
   "playerAttributes":{
      "displayName":"Jon Snow",
      "email":"jon.snow@example.com",
      "mobileNumber":"0123456789",
      "gender":"M",
      "joinDate":"09/19/2019 21:06:29",
      "tags":[
         "VIP",
         "Elite"
      ],
      "custom":{
         "location":"Miami",
         "graduationDate":"2018-07-04T21:06:29.158Z",
         "isMarried":false
      }
   },
   "referralCode":"CODE12",
   "referralLink":"https://gameofthrones.myshopify.com/account/register?ReferralCode=CODE12",
   "dynamicReferralLink":"https://gameofthrones.myshopify.com/account/register?ReferralCode=CODE12",
   "level":{
      "name":"Gold",
      "description":null,
      "levelOrder":4,
      "iconPath":"https://cdn.gameball.co/uploads/Client 1/2cf4b388-f957-4789-8309-5476907c1baeicon-level-gold@2x.png",
      "benefits":{
         "scoreEntryReward":0,
         "pointsEntryReward":0,
         "levelDiscount":null,
         "discountCapping":null
      }
   },
    "levelProgress": 0,
    "points": {
        "pointsBalance": 0,
        "pointsValue": 0.0,
        "pendingPoints": 0,
        "pendingPointsValue": 0.0,
        "currency": "USD",
        "walletPointsName": "Points",
        "totalPositivePoints": 0,
        "totalPositivePendingPoints": 0,
        "totalNegativePoints": 0,
        "totalNegativePendingPoints": 0
    }
}

Usage Example

The example shown is a request sent to Gameball to get a customer info with playerUniqueIdβ€œplayer456”.

curl -X GET -H 'apiKey: 807b041b7d35425988e354e1f6bce186'
 -v -i 'https://api.gameball.co/api/v3.0/integrations/player/player456'

GET - Customer's Balance

This API call is used to retrieve customer's current points balance available for redemption and the corresponding equivalent amount.

https://api.gameball.co/api/v3.0/integrations/player/{playerUnqiueId}/balance

mobile or email should replace playerUniqueId in case (only if) your account supports channel merging.

Request

Header

Attribute

Type

Required

Description

APIKey

string

Yes

Client APIKey

secretKey

string

Yes

Client Secret Key

Path Parameters

Parameter

Type

Required

Description

playerUniqueId

string

Yes

Unique identifier for the customer at Gameball. Note: in case your account supports channel merging, mobile or email could be used instead of playerUniqueId

Response

ParameterTypeDescription

pointsBalance

integer

Customer current points balance.

pointsValue

integer

The customer's equivalent monetary value topointsBalance according to your Cashback program configurations.

pendingPoints

integer

Customer current pending points. (Not active yet, therefore cannot be used at this moment)

pendingPointsValue

integer

The customer's equivalent monetary value to pendingPoints according to your Cashback program configurations.

totalPositivePoints

integer

Customer current total positive points.

totalPositivePendingPoints

integer

Customer current positive pending points.

totalNegativePoints

integer

Customer current total negative points.

totalNegativePendingPoints

integer

Customer current negative pending points.

currency

string

Store currency.

pointsName

string

The naming of the rewarding points that appears to the customer.

Sample Response

{
    "pointsBalance": 11500,
    "pointsValue": 115,
    "pendingPoints": 200,
    "pendingPointsValue": 2,
    "totalPositivePoints": 12500,
    "totalPositivePendingPoints": 135,
    "totalNegativePoints": 1000,
    "totalNegativePendingPoints": 20
    "currency": "USD",
    "pointsName": "Points"
}

Usage Example

The example shown is a request sent to Gameball to get a customer's balance with his playerUniqueId

curl -X GET -H 'apiKey: 807b041b7d35425988e354e1f6bce186' \
       -H 'secretKey: klmb041b7d354259l3u4ft35e1q2r3703' -d 
-v -i 'https://api.gameball.co/api/v3.0/integrations/player/player456/balance'

GET - Customer's Hash

This API call is used to retrieve customer's hash value which is calculated for each customer, and rotates with the customer's every transaction.

https://api.gameball.co/api/v3.0/integrations/player/{playerUnqiueId}/hash

mobile or email should replace playerUniqueId in case (only if) your account supports channel merging.

Request

Header

Attribute

Type

Required

Description

APIKey

string

Yes

Client APIKey

secretKey

string

Yes

Client Secret Key

Path Parameters

Parameter

Type

Required

Description

playerUniqueId

string

Yes

Unique identifier for the customer at Gameball. Note: in case your account supports channel merging, mobile or email could be used instead of playerUniqueId

Response

Parameter

Type

Description

playerUniqueId

string

Unique identifier for the customer at Gameball.

referralCode

string

Customer's Referral Code. Used to refer another customer.

referralLink

string

Referral URL.

dynamicReferralLink

string

Referral URL for mobile APPs integrations with firebase.

pointsBalance

integer

Customer current points balance.

pointsValue

number

The customer's equivalent monetary value topointsBalance according to your Cashback program configurations.

pendingPoints

integer

Customer current pending points. (Not active yet, therefore cannot be used at this moment)

pendingPointsValue

number

The customer's equivalent monetary value to pendingPoints according to your Cashback program configurations.

currency

string

Store currency.

pointsName

string

The naming of the rewarding points that appears to the customer.

hash

string

A secret number hash that is calculated for each customer, and rotates with the customer's every transaction.

Sample Response

   {
    "pLayerId": 406044,
    "playerUniqueId": "6886288195890",
    "displayName": "m3 z3",
    "firstName": "m3",
    "lastName": "z3",
    "gender": null,
    "email": "mariam.zakria+f12@gameball.co",
    "mobileNumber": null,
    "dateOfBirth": null,
    "joinDate": "2023-03-01T10:28:30",
    "referralCode": "ED1D58A3vTiok9",
    "referralLink": "https://gbdashboardv2-gbx.myshopify.com/account/register?ReferralCode=ED1D58A3vTiok9",
    "dynamicReferralLink": null,
    "levelName": "Basico",
    "levelIconPath": "https://cdn.gameball.co/uploads/gb-library/levels-icons/level-a1.png",
    "pointsBalance": 945,
    "pointsValue": 94.5,
    "pendingPoints": 0,
    "pendingPointsValue": 0,
    "pointsToExpire": 555,
    "pointsToExpireValue": 55.5,
    "expiryDate": "2023-03-02T12:23:59.885053",
    "currency": "AED",
    "pointsName": "Puntos",
    "lastActivePointsStatus": 555,
    "lastPendingPointsStatus": 0,
    "lastLevelStatus": "none",
    "lastActivePointsDate": "2023-03-01T12:23:59.913354",
    "lastPendingPointsDate": null,
    "lastLevelDate": null,
    "hash": "502371"
  }

Usage Example

The example shown is a request sent to Gameball to get a customer's balance with his playerUniqueId

curl -X GET -H 'apiKey: 807b041b7d35425988e354e1f6bce186' 
       -H 'secretKey: klmb041b7d354259l3u4ft35e1q2r3703' -d 
-v -i 'https://api.gameball.co/api/v3.0/integrations/player/player456/balance'

GET - Customer's Progress πŸ‘‘

https://api.gameball.co/api/v3.0/integrations/player/{playerUnqiueId}/progress

mobile or email should replace playerUniqueId in case (only if) your account supports channel merging.

This API call is used to show the overall customer's progress in the available rewards campaigns, referral program and VIP tiers across Gameball programs.

This endpoint is only available for our GURU clients only πŸ‘‘

Request

Header

Attribute

Type

Required

Description

APIKey

string

Yes

Client APIKey

secretKey

string

Yes

Client Secret Key

Path Parameters

Parameter

Type

Required

Description

playerUniqueId

string

Yes

Unique identifier for the customer at Gameball.

Response

Parameter

Type

Description

playerUniqueId

string

Unique identifier for the customer at Gameball.

referralCode

string

Customer's referral code.

referralLink

string

Customer's referral link.

dynamicReferralLink

string

Referral URL for mobile APPs integrations with firebase.

playerAttributes

object

An object with set of customer properties.

levelsProgress

object

An object contains the VIP tier information of the current and the next VIP tier (empty if the customer is on top VIP tier already) of the specified customer.

The Level object is described as follows:

  • order: VIP tier's tier e.g., VIP tier 1, VIP tier 2, VIP tier 3.

  • name: VIP tier name.

  • minProgress: Minimum score to be in that VIP tier .

  • icon: The icon URL describing the VIP tier .

  • progress: The current progress of customer on the VIP tier .

challengesProgress

array

An array of rewards campaigns objects where each describe an available rewards campaigns for the customer and his progress in each.

totalReferredPlayers

integer

The total number of the customer's referred customers.

balance

object

An object that describes the customer's current balance.

balanceObject

The balance object contains info about the customer's points.

Parameter

Type

Description

pointsBalance

integer

Customer current points balance.

pointsValue

number

The customer's equivalent monetary value topointsBalance according to your Cashback program configurations.

pendingPoints

integer

Customer current pending points. (Not active yet, therefore cannot be used at this moment)

pendingPointsValue

number

The customer's equivalent monetary value to pendingPoints according to your Cashback program configurations.

currency

string

Your system currency as configured at Gameball.

pointsName

string

The naming of the rewarding points that appears to the customer.

challenge Object

The challenge object shows description of the rewards campaigns as follows.

Parameter

Type

Description

isUnlocked

boolean

Indicates whether the rewards campaigns is unlocked for this customer or not.

highScoreAmount

integer

Indicates the customer's High Score. Note: This field is provided in case the rewards campaign is a High Score rewards campaign.

currentStreak

integer

The current streak refers to the count of the most recent and uninterrupted series of consecutive events or occurrences.

highestStreak

integer

The highest streak refers to the count of the longest unbroken sequence of events or occurrences achieved at any point in time.

completionPercentage

number

Shows the customer's current progress towards achieving the rewards campaign.

achievedCount

integer

The number of times this rewards campaign has been achieved by the customer.

challengeConfig

object

AchallengeConfigObject that describes the details of the rewards campaign.

challengeConfig Object

AttributeTypeDescription

id

integer

Rewards Campaign Id.

name

string

Rewards Campaign internal name.

description

string

Rewards Campaign description.( In default language if not specified in query parameter)

rewards

array

An array of Reward objects, these are the rewards that are achieved by completing the specified Rewards Campaign.

isRepeatable

boolean

A boolean indicating if the Rewards Campaign is repeatable for the specified customer or not.

maxAchievement

integer

Maximum number of times the specified Rewards Campaign can be achieved. (-1 if can be achieved for an unlimited number of times)

type

string

Rewards Campaign type, can be one of the following:

  • Amount Based

  • Action Based

  • ActionBasedAndAmountBased

  • HighScore

  • UponLogin

  • NonCumulativeAmountBased

  • JoinAnniversary

  • EventBased

  • SocialActivities

  • ScheduledChallenge

  • Streak

visibility

string

Rewards Campaign visibility type, can be one of the following:

  • Always Visible

  • Not Visible

  • Visible If Earned

icon

string

URI indicating the file path to the icon of the rewards campaign.

availability

Object

An availability object specifying the conditions where this rewards campaignis available.

redirectionButtonText

string

The text written on the redirection button. (In case the redirection button is enabled for this rewards campaign).

redirectionButtonLink

string

The redirection link. (In case the redirection button is enabled for this rewards campaign)

reward Object

AttributeTypeDescription

rankReward

integer

Progress rewarded towards rank.

walletReward

integer

Points rewarded in wallet.

couponReward

Object

Coupon object that describes the coupon that is rewarded when completing this rewards campaign.

couponReward Object

AttributeTypeDescription

couponType

string

Coupon type, can be one of the following:

  • Fixed

  • Percentage

  • Free Shipping

  • Free Product

  • Fixed Rate Discount

discountValue

double

Value of coupon, for example if the coupon rewards a fixed amount of points then the amount of points will be in discountValue.

minOrderValue

double

Minimum order value that this coupon can be applied to.

product

Object

In the case of a free product coupon this object indicates the details of the product,

The object has the the following attributes:

  • productId

  • productName

  • variantId

  • variantName

collections

array

Array of Collection objects in the case where the coupon can only be applied to specific collections, the collection object has the following attributes:

  • collectionId

  • collectionName

availability Object

AttributeTypeDescription

minLevel

integer

Minimum VIP tier where this rewards campaign is available.

tags

array

An array of Tag names. (string)

Sample Response

{
  "playerUniqueId": "player456",
  "referralCode": "CODE12",
  "referralLink": "https://gameofthrones.myshopify.com/account/register?ReferralCode=CODE12",
  "dynamicReferralLink": "https://gameofthrones.myshopify.com/account/register?ReferralCode=CODE12",
  "playerAttributes": {
    "dateOfBirth": null,
    "communityId": null,
    "tags": ["VIP"]
  },
  "levelsProgress": {
    "current": {
      "order": 1,
      "name": "level 1",
      "minProgress": 0,
      "icon": "https://cdn.gameball.co/uploads/client776/ad8b2587-959f-48fd-ab58-a643323652begb.png"
    },
    "next": {
      "order": 2,
      "name": "level 2",
      "minProgress": 2000,
      "icon": "https://cdn.gameball.co/uploads/client776/ad8b2587-959f-48fd-ab58-a643323652begb.png"
    }
  },
  "challengesProgress": [
    {
      "isUnlocked": true,
      "highScoreAmount": null,
      "completionPercentage": 0,
      "achievedCount": 0,
      "challengeConfig": {
        "id": 1234,
        "name": "Challenge Name",
        "description": "Challenge Description",
        "rewards": [
          {
            "rankReward": 0,
            "walletReward": 0,
            "couponReward": {
              "couponType": "Free Product",
              "discountValue": null,
              "minOrderValue": null,
              "product": {
                "productId": "123456789",
                "productName": "Chequered Red Shirt",
                "variantId": "123456789",
                "variantName": null
              },
              "collections": []
            }
          }
        ],
        "isRepeatable": true,
        "maxAchievement": -1,
        "type": "EventBased",
        "visibility": "Always Visible",
        "icon": "https://s3.us-east-2.amazonaws.com/gameball.dev.uploads/uploads/gb-library/general/annoncement.png",
        "availability": {
          "minLevel": 1,
          "tags": []
        },
        "redirectionButtonText": "Free Gift",
        "redirectionButtonLink": "https://claires.myshopify.com/products/jeans"
      }
    }
  ],
  "totalReferredPlayers": 0,
  "points": {
    "pointsBalance": 11500,
    "pointsValue": 115,
    "pendingPoints": 200,
    "pendingPointsValue": 2,
    "currency": "USD",
    "pointsName": "Points"
  }
}

Usage Example

The example shown is a request sent to Gameball to get a customer's progress with playerUniqueIdβ€œplayer456”.

curl -X POST -H 'apiKey: 807b041b7d35425988e354e1f6bce186'
 -v -i 'https://api.gameball.co/api/v3.0/integrations/player/player456/progress'

GET - Customer's Rewards Campaign's Progress

This API is used to get a customer's specific rewards campaign's progress.

https://api.gameball.co/api/v3.0/integrations/player/{playerUnqiueId}/progress/challenge/{handle}

Request

Header

Attribute

Type

Required

Description

APIKey

string

Yes

Client API key

secretKey

string

Yes

Client Secret Key

Path Parameters

Attribute

Type

Required

Description

playerUniqueId

string

Yes

Unique identifier for the

customer at Gameball.

handle

string

Yes

Identifier of the rewards campaign, either the challengeId, or the rewards campaign internal name.(Note: If rewards campaign name has the space character please replace it with customer would be New%20customer)

Query Parameters

Attribute

Type

Required

Description

lang

string

No

The language you wish to retrieve the information in.