Create/Update Customer

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 Channel Merging 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.

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.

Show child attributes

customerAttributes.displayName

string

Display name for the customer.

customerAttributes.firstName

string

Customer's first name.

customerAttributes.lastName

string

Customer's last name.

customerAttributes.email

string

Customer's email address.

customerAttributes.gender

string

Customer's gender.

customerAttributes.mobile

string

Customer's mobile number.

customerAttributes.dateOfBirth

string

Customer's date of birth.

customerAttributes.joinDate

string

Date the customer joined.

customerAttributes.country

string

Customer's country.

customerAttributes.city

string

Customer's city.

customerAttributes.zip

string

Customer's postal code.

customerAttributes.preferredLanguage

string

The customer's preferred language for communication and interactions. This is typically used to personalize notifications, messages, and other system interactions based on the customer's language preference.

customerAttributes.source

string

Source of the customer registration.

customerAttributes.utms

array

List of UTM attributes associated with the customer.

customerAttributes.devices

array

List of devices associated with the customer.

customerAttributes.paymentMethods

array

List of payment methods used by the customer. This array may include various forms of payment, such as credit cards, PayPal, or other payment providers. Each payment method is represented as a string.

customerAttributes.totalSpent

number

Total amount spent by the customer.

customerAttributes.lastOrderDate

string

Date of the last order placed by the customer.

customerAttributes.totalOrders

integer

Total number of orders placed by the customer.

customerAttributes.avgOrderAmount

number

Average amount spent per order by this customer.

customerAttributes.channel

enum<string>

Indicates the channel through which the customer was acquired or engaged. This is especially useful for systems that support multiple channels to track customer origin and interactions. Understanding the acquisition or engagement channel helps in tailoring marketing strategies, optimizing communication, and analyzing customer preferences.

Available options:

mobile,

pos,

web,

callcenter

customerAttributes.custom

object

Key-value pairs that allow you to store additional attributes for the customer. This can include any extra information specific to your needs, enabling more personalized interactions and offerings.

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

Authorizations

Body

Response