Skip to main content
POST
/
api
/
v4.0
/
integrations
/
customers
Create Customer
curl --request POST \
  --url https://api.gameball.co/api/v4.0/integrations/customers \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "customerId": "<string>",
  "email": "<string>",
  "mobile": "<string>",
  "deviceToken": "<string>",
  "osType": "<string>",
  "customerAttributes": {
    "displayName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "gender": "<string>",
    "mobile": "<string>",
    "dateOfBirth": "<string>",
    "joinDate": "<string>",
    "country": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "preferredLanguage": "<string>",
    "source": "<string>",
    "utms": "<array>",
    "devices": "<array>",
    "paymentMethods": "<array>",
    "totalSpent": 123,
    "lastOrderDate": "<string>",
    "totalOrders": 123,
    "avgOrderAmount": 123,
    "custom": {}
  },
  "referrerCode": "<string>",
  "guest": true
}
'
{
  "gameballId": 123
}
This API enables you to create or update a customer profile in Gameball using a unique customerId. Serving as a consistent identity, this customerId allows you to track a customer’s entire journey, linking them to all associated events, purchases, and loyalty activities across their lifetime. This ensures comprehensive customer management within the Gameball platform.
Security: Requires apiKey header.
Channel Merging Available
If your system uses different customer IDs across multiple channels (e.g., online and offline), Gameball’s channel merging feature helps unify customer profiles. By including the customer’s mobile number or email (based on your merging configuration) with each request, Gameball will combine activities into a single profile.For more information, head to the Omni-Channel Handling Guide.

Authorizations

​
apikey
string
header
required

Body

application/json

Customer payload containing identifiers and attributes.

​
customerId
string
required

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.

​
email
string

Customer's email address. Required if your account uses email-based channel merging.

​
mobile
string

Customer's mobile number. Required if your account uses mobile-based channel merging.

​
deviceToken
string

Token used to identify the device.

​
osType
string

Operating system type of the device.

​
customerAttributes
object

Additional customer-specific attributes. Includes attributes such as the customer's name, contact details, and purchase history.

​
referrerCode
string

The referral code of an existing customer who is referring the customer being created. This is required in the create customer request to process the referral.

​
guest
boolean

A flag indicating if the individual interacting with your system is a guest (not signed up). Set this to true for guest users; otherwise, they are treated as registered customers by default.

Response

200 - application/json

Customer created or updated successfully

​
gameballId
number

The customer's unique ID within the Gameball system. This ID is used to store the customer in our database and is different from the customerId used in the dashboard.