Players

Players API is responsible for creating players.

Player

POST /Integrations/InitializePlayer

Headers

Name	Type	Description
APIKey	string	client API key

Request Body

Name	Type	Description
playerUniqueId	string	Player external ID used by integrator to uniquely identify the player in Gameball
displayName	string	Player's Name
email	string	Player's email
dateOfBirth	string	Player's date of birth
gender	string	Player's gender
mobileNumber	string	Player's phone
joinDate	string	The date the player joined Gameball
custom	object	player's custom attributes that could be added (eg: location, height)

200

Success

401

{“error”:”Invalid API key.”}

403

{“error”:”API key is missing.”}

404

{“error”:”Invalid\Expired OTP “}

500

{“error”:”Something went wrong. Please try again later.”}

Examples

The example shown is a request sent to Gameball to create a player with playerUniqueId“ac2635be”and with some custom attributes inside the custom Object.

All attributes should be inside the playerAttributes object, if the values of any attributes shown below are unavailable, remove the attribute from the playerAttributes object.

{
  "playerUniqueId": "ac2636be",
  "playerAttributes": {
    "displayName": "John Doe",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]",
    "mobileNumber": "011111111111",
    "gender": "M",
    "dateOfBirth": "2019-09-19T21:06:29.158Z",
    "joinDate": "2019-09-19T21:06:29.158Z",
    "custom": {
      "location": "Cairo",
      "height": 180,
      "graduationDate": "2019-09-19T21:06:29.158Z",
      "isMarried": true //boolean values (true or false)
    }
  }
}