Create/Update Customer

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>",
  "pushServiceProvider": "Firebase",
  "osType": "<string>",
  "customerAttributes": {
    "displayName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "gender": "<string>",
    "mobile": "<string>",
    "mobileCountryCode": "<string>",
    "dateOfBirth": "<string>",
    "joinDate": "<string>",
    "country": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "preferredLanguage": "<string>",
    "source": "<string>",
    "utms": "<array>",
    "devices": [
      {
        "userAgent": "<string>",
        "os": "<string>",
        "device": "<string>",
        "browser": "<string>"
      }
    ],
    "paymentMethods": "<array>",
    "totalSpent": 123,
    "lastOrderDate": "<string>",
    "totalOrders": 123,
    "avgOrderAmount": 123,
    "custom": {}
  },
  "referrerCode": "<string>",
  "guest": true
}
'

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customerId: '<string>',
    email: '<string>',
    mobile: '<string>',
    deviceToken: '<string>',
    pushServiceProvider: 'Firebase',
    osType: '<string>',
    customerAttributes: {
      displayName: '<string>',
      firstName: '<string>',
      lastName: '<string>',
      email: '<string>',
      gender: '<string>',
      mobile: '<string>',
      mobileCountryCode: '<string>',
      dateOfBirth: '<string>',
      joinDate: '<string>',
      country: '<string>',
      city: '<string>',
      zip: '<string>',
      preferredLanguage: '<string>',
      source: '<string>',
      utms: '<array>',
      devices: [
        {userAgent: '<string>', os: '<string>', device: '<string>', browser: '<string>'}
      ],
      paymentMethods: '<array>',
      totalSpent: 123,
      lastOrderDate: '<string>',
      totalOrders: 123,
      avgOrderAmount: 123,
      custom: {}
    },
    referrerCode: '<string>',
    guest: true
  })
};

fetch('https://api.gameball.co/api/v4.0/integrations/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.gameball.co/api/v4.0/integrations/customers"

payload = {
    "customerId": "<string>",
    "email": "<string>",
    "mobile": "<string>",
    "deviceToken": "<string>",
    "pushServiceProvider": "Firebase",
    "osType": "<string>",
    "customerAttributes": {
        "displayName": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "gender": "<string>",
        "mobile": "<string>",
        "mobileCountryCode": "<string>",
        "dateOfBirth": "<string>",
        "joinDate": "<string>",
        "country": "<string>",
        "city": "<string>",
        "zip": "<string>",
        "preferredLanguage": "<string>",
        "source": "<string>",
        "utms": "<array>",
        "devices": [
            {
                "userAgent": "<string>",
                "os": "<string>",
                "device": "<string>",
                "browser": "<string>"
            }
        ],
        "paymentMethods": "<array>",
        "totalSpent": 123,
        "lastOrderDate": "<string>",
        "totalOrders": 123,
        "avgOrderAmount": 123,
        "custom": {}
    },
    "referrerCode": "<string>",
    "guest": True
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.gameball.co/api/v4.0/integrations/customers");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("apikey", "<api-key>");
request.AddJsonBody("{\n  \"customerId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"deviceToken\": \"<string>\",\n  \"pushServiceProvider\": \"Firebase\",\n  \"osType\": \"<string>\",\n  \"customerAttributes\": {\n    \"displayName\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"gender\": \"<string>\",\n    \"mobile\": \"<string>\",\n    \"mobileCountryCode\": \"<string>\",\n    \"dateOfBirth\": \"<string>\",\n    \"joinDate\": \"<string>\",\n    \"country\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"preferredLanguage\": \"<string>\",\n    \"source\": \"<string>\",\n    \"utms\": \"<array>\",\n    \"devices\": [\n      {\n        \"userAgent\": \"<string>\",\n        \"os\": \"<string>\",\n        \"device\": \"<string>\",\n        \"browser\": \"<string>\"\n      }\n    ],\n    \"paymentMethods\": \"<array>\",\n    \"totalSpent\": 123,\n    \"lastOrderDate\": \"<string>\",\n    \"totalOrders\": 123,\n    \"avgOrderAmount\": 123,\n    \"custom\": {}\n  },\n  \"referrerCode\": \"<string>\",\n  \"guest\": true\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gameball.co/api/v4.0/integrations/customers"

	payload := strings.NewReader("{\n  \"customerId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"deviceToken\": \"<string>\",\n  \"pushServiceProvider\": \"Firebase\",\n  \"osType\": \"<string>\",\n  \"customerAttributes\": {\n    \"displayName\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"gender\": \"<string>\",\n    \"mobile\": \"<string>\",\n    \"mobileCountryCode\": \"<string>\",\n    \"dateOfBirth\": \"<string>\",\n    \"joinDate\": \"<string>\",\n    \"country\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"preferredLanguage\": \"<string>\",\n    \"source\": \"<string>\",\n    \"utms\": \"<array>\",\n    \"devices\": [\n      {\n        \"userAgent\": \"<string>\",\n        \"os\": \"<string>\",\n        \"device\": \"<string>\",\n        \"browser\": \"<string>\"\n      }\n    ],\n    \"paymentMethods\": \"<array>\",\n    \"totalSpent\": 123,\n    \"lastOrderDate\": \"<string>\",\n    \"totalOrders\": 123,\n    \"avgOrderAmount\": 123,\n    \"custom\": {}\n  },\n  \"referrerCode\": \"<string>\",\n  \"guest\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gameball.co/api/v4.0/integrations/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customerId' => '<string>',
    'email' => '<string>',
    'mobile' => '<string>',
    'deviceToken' => '<string>',
    'pushServiceProvider' => 'Firebase',
    'osType' => '<string>',
    'customerAttributes' => [
        'displayName' => '<string>',
        'firstName' => '<string>',
        'lastName' => '<string>',
        'email' => '<string>',
        'gender' => '<string>',
        'mobile' => '<string>',
        'mobileCountryCode' => '<string>',
        'dateOfBirth' => '<string>',
        'joinDate' => '<string>',
        'country' => '<string>',
        'city' => '<string>',
        'zip' => '<string>',
        'preferredLanguage' => '<string>',
        'source' => '<string>',
        'utms' => '<array>',
        'devices' => [
                [
                                'userAgent' => '<string>',
                                'os' => '<string>',
                                'device' => '<string>',
                                'browser' => '<string>'
                ]
        ],
        'paymentMethods' => '<array>',
        'totalSpent' => 123,
        'lastOrderDate' => '<string>',
        'totalOrders' => 123,
        'avgOrderAmount' => 123,
        'custom' => [
                
        ]
    ],
    'referrerCode' => '<string>',
    'guest' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://api.gameball.co/api/v4.0/integrations/customers")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"deviceToken\": \"<string>\",\n  \"pushServiceProvider\": \"Firebase\",\n  \"osType\": \"<string>\",\n  \"customerAttributes\": {\n    \"displayName\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"gender\": \"<string>\",\n    \"mobile\": \"<string>\",\n    \"mobileCountryCode\": \"<string>\",\n    \"dateOfBirth\": \"<string>\",\n    \"joinDate\": \"<string>\",\n    \"country\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"preferredLanguage\": \"<string>\",\n    \"source\": \"<string>\",\n    \"utms\": \"<array>\",\n    \"devices\": [\n      {\n        \"userAgent\": \"<string>\",\n        \"os\": \"<string>\",\n        \"device\": \"<string>\",\n        \"browser\": \"<string>\"\n      }\n    ],\n    \"paymentMethods\": \"<array>\",\n    \"totalSpent\": 123,\n    \"lastOrderDate\": \"<string>\",\n    \"totalOrders\": 123,\n    \"avgOrderAmount\": 123,\n    \"custom\": {}\n  },\n  \"referrerCode\": \"<string>\",\n  \"guest\": true\n}")
  .asString();

{
  "gameballId": 123
}

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>",
  "pushServiceProvider": "Firebase",
  "osType": "<string>",
  "customerAttributes": {
    "displayName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "gender": "<string>",
    "mobile": "<string>",
    "mobileCountryCode": "<string>",
    "dateOfBirth": "<string>",
    "joinDate": "<string>",
    "country": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "preferredLanguage": "<string>",
    "source": "<string>",
    "utms": "<array>",
    "devices": [
      {
        "userAgent": "<string>",
        "os": "<string>",
        "device": "<string>",
        "browser": "<string>"
      }
    ],
    "paymentMethods": "<array>",
    "totalSpent": 123,
    "lastOrderDate": "<string>",
    "totalOrders": 123,
    "avgOrderAmount": 123,
    "custom": {}
  },
  "referrerCode": "<string>",
  "guest": true
}
'

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customerId: '<string>',
    email: '<string>',
    mobile: '<string>',
    deviceToken: '<string>',
    pushServiceProvider: 'Firebase',
    osType: '<string>',
    customerAttributes: {
      displayName: '<string>',
      firstName: '<string>',
      lastName: '<string>',
      email: '<string>',
      gender: '<string>',
      mobile: '<string>',
      mobileCountryCode: '<string>',
      dateOfBirth: '<string>',
      joinDate: '<string>',
      country: '<string>',
      city: '<string>',
      zip: '<string>',
      preferredLanguage: '<string>',
      source: '<string>',
      utms: '<array>',
      devices: [
        {userAgent: '<string>', os: '<string>', device: '<string>', browser: '<string>'}
      ],
      paymentMethods: '<array>',
      totalSpent: 123,
      lastOrderDate: '<string>',
      totalOrders: 123,
      avgOrderAmount: 123,
      custom: {}
    },
    referrerCode: '<string>',
    guest: true
  })
};

fetch('https://api.gameball.co/api/v4.0/integrations/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.gameball.co/api/v4.0/integrations/customers"

payload = {
    "customerId": "<string>",
    "email": "<string>",
    "mobile": "<string>",
    "deviceToken": "<string>",
    "pushServiceProvider": "Firebase",
    "osType": "<string>",
    "customerAttributes": {
        "displayName": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "gender": "<string>",
        "mobile": "<string>",
        "mobileCountryCode": "<string>",
        "dateOfBirth": "<string>",
        "joinDate": "<string>",
        "country": "<string>",
        "city": "<string>",
        "zip": "<string>",
        "preferredLanguage": "<string>",
        "source": "<string>",
        "utms": "<array>",
        "devices": [
            {
                "userAgent": "<string>",
                "os": "<string>",
                "device": "<string>",
                "browser": "<string>"
            }
        ],
        "paymentMethods": "<array>",
        "totalSpent": 123,
        "lastOrderDate": "<string>",
        "totalOrders": 123,
        "avgOrderAmount": 123,
        "custom": {}
    },
    "referrerCode": "<string>",
    "guest": True
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.gameball.co/api/v4.0/integrations/customers");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("apikey", "<api-key>");
request.AddJsonBody("{\n  \"customerId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"deviceToken\": \"<string>\",\n  \"pushServiceProvider\": \"Firebase\",\n  \"osType\": \"<string>\",\n  \"customerAttributes\": {\n    \"displayName\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"gender\": \"<string>\",\n    \"mobile\": \"<string>\",\n    \"mobileCountryCode\": \"<string>\",\n    \"dateOfBirth\": \"<string>\",\n    \"joinDate\": \"<string>\",\n    \"country\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"preferredLanguage\": \"<string>\",\n    \"source\": \"<string>\",\n    \"utms\": \"<array>\",\n    \"devices\": [\n      {\n        \"userAgent\": \"<string>\",\n        \"os\": \"<string>\",\n        \"device\": \"<string>\",\n        \"browser\": \"<string>\"\n      }\n    ],\n    \"paymentMethods\": \"<array>\",\n    \"totalSpent\": 123,\n    \"lastOrderDate\": \"<string>\",\n    \"totalOrders\": 123,\n    \"avgOrderAmount\": 123,\n    \"custom\": {}\n  },\n  \"referrerCode\": \"<string>\",\n  \"guest\": true\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gameball.co/api/v4.0/integrations/customers"

	payload := strings.NewReader("{\n  \"customerId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"deviceToken\": \"<string>\",\n  \"pushServiceProvider\": \"Firebase\",\n  \"osType\": \"<string>\",\n  \"customerAttributes\": {\n    \"displayName\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"gender\": \"<string>\",\n    \"mobile\": \"<string>\",\n    \"mobileCountryCode\": \"<string>\",\n    \"dateOfBirth\": \"<string>\",\n    \"joinDate\": \"<string>\",\n    \"country\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"preferredLanguage\": \"<string>\",\n    \"source\": \"<string>\",\n    \"utms\": \"<array>\",\n    \"devices\": [\n      {\n        \"userAgent\": \"<string>\",\n        \"os\": \"<string>\",\n        \"device\": \"<string>\",\n        \"browser\": \"<string>\"\n      }\n    ],\n    \"paymentMethods\": \"<array>\",\n    \"totalSpent\": 123,\n    \"lastOrderDate\": \"<string>\",\n    \"totalOrders\": 123,\n    \"avgOrderAmount\": 123,\n    \"custom\": {}\n  },\n  \"referrerCode\": \"<string>\",\n  \"guest\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gameball.co/api/v4.0/integrations/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customerId' => '<string>',
    'email' => '<string>',
    'mobile' => '<string>',
    'deviceToken' => '<string>',
    'pushServiceProvider' => 'Firebase',
    'osType' => '<string>',
    'customerAttributes' => [
        'displayName' => '<string>',
        'firstName' => '<string>',
        'lastName' => '<string>',
        'email' => '<string>',
        'gender' => '<string>',
        'mobile' => '<string>',
        'mobileCountryCode' => '<string>',
        'dateOfBirth' => '<string>',
        'joinDate' => '<string>',
        'country' => '<string>',
        'city' => '<string>',
        'zip' => '<string>',
        'preferredLanguage' => '<string>',
        'source' => '<string>',
        'utms' => '<array>',
        'devices' => [
                [
                                'userAgent' => '<string>',
                                'os' => '<string>',
                                'device' => '<string>',
                                'browser' => '<string>'
                ]
        ],
        'paymentMethods' => '<array>',
        'totalSpent' => 123,
        'lastOrderDate' => '<string>',
        'totalOrders' => 123,
        'avgOrderAmount' => 123,
        'custom' => [
                
        ]
    ],
    'referrerCode' => '<string>',
    'guest' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://api.gameball.co/api/v4.0/integrations/customers")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"deviceToken\": \"<string>\",\n  \"pushServiceProvider\": \"Firebase\",\n  \"osType\": \"<string>\",\n  \"customerAttributes\": {\n    \"displayName\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"gender\": \"<string>\",\n    \"mobile\": \"<string>\",\n    \"mobileCountryCode\": \"<string>\",\n    \"dateOfBirth\": \"<string>\",\n    \"joinDate\": \"<string>\",\n    \"country\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"preferredLanguage\": \"<string>\",\n    \"source\": \"<string>\",\n    \"utms\": \"<array>\",\n    \"devices\": [\n      {\n        \"userAgent\": \"<string>\",\n        \"os\": \"<string>\",\n        \"device\": \"<string>\",\n        \"browser\": \"<string>\"\n      }\n    ],\n    \"paymentMethods\": \"<array>\",\n    \"totalSpent\": 123,\n    \"lastOrderDate\": \"<string>\",\n    \"totalOrders\": 123,\n    \"avgOrderAmount\": 123,\n    \"custom\": {}\n  },\n  \"referrerCode\": \"<string>\",\n  \"guest\": true\n}")
  .asString();

{
  "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.

Registering a Push Token

To send mobile push notifications to a customer, register their device token with this API, either from your server or through the Gameball mobile SDKs. Send deviceToken together with pushServiceProvider:

{
  "customerId": "cust_123",
  "deviceToken": "<FCM or HMS token>",
  "pushServiceProvider": "Firebase", // "Firebase" (default) or "Huawei"
  "osType": "iOS"
}

Field	Available options	Default
`pushServiceProvider`	`Firebase` (Firebase Cloud Messaging), `Huawei` (Huawei Push Kit)	`Firebase`

Use the option exactly as spelled above. When you omit pushServiceProvider, the token is treated as a Firebase token, so always send Huawei for Huawei Push Kit tokens.

The field has a different name in the API and in the SDKs:

Where you register the token	Field name	Example
REST API (this endpoint and the Create Customers Batch Job)	`pushServiceProvider`	`"pushServiceProvider": "Firebase"`
iOS SDK	`pushProvider`	`pushProvider: .firebase`
Android SDK	`pushProvider`	`.pushProvider(PushProvider.Firebase)`
Flutter SDK	`pushProvider`	`.pushProvider(PushProvider.firebase)`
React Native SDK	`pushProvider`	`pushProvider: PushProvider.firebase`

Over REST, only pushServiceProvider is read. Any other name, such as pushProvider, is ignored and returned in the x-gameball-unknown-fields response header.

A customer can have several devices. Each new token is added, and tokens registered earlier keep receiving notifications until the push service reports them as invalid. Gameball has no API to remove a token, so a device keeps receiving the customer’s notifications after the customer logs out.
Sending a token that is already registered has no effect.
The token is registered after the request returns, so a 200 response does not confirm the registration.

customerAttributes.devices is unrelated to push notifications. It holds descriptive device and browser details (userAgent, os, device, browser), and push tokens never appear in it.

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.

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

Push notification token for the customer's device (an FCM token, or an HMS Push Kit token for Huawei), used to deliver mobile push campaigns. Send it with pushServiceProvider. Each new token is added to the customer's registered devices, and tokens registered earlier are kept.

pushServiceProvider

enum<string>

default:Firebase

Push service that issued deviceToken: Firebase or Huawei, spelled exactly as shown. Send it whenever you send deviceToken. When it is omitted, the token is treated as a Firebase token, so Huawei tokens registered without it never receive push notifications. In the mobile SDKs this field is called pushProvider.

Available options:

Firebase,

Huawei

osType

string

Operating system of the device, for example iOS or Android.

customerAttributes

object

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

Show child attributes

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.

API documentation

Webhooks

Registering a Push Token

Authorizations

Body

Response

​Registering a Push Token

Authorizations

Body

Response

Registering a Push Token