curl --request POST \
--url https://api.gameball.co/api/v4.0/integrations/batch/customers \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"body": [
{
"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,
"channel": "mobile",
"custom": {}
},
"referrerCode": "<string>",
"guest": true
}
]
}
'{
"jobId": 123
}Create Customers Batch Job
Create or update multiple customer profiles in a single API call for bulk user imports and mass profile updates.
curl --request POST \
--url https://api.gameball.co/api/v4.0/integrations/batch/customers \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"body": [
{
"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,
"channel": "mobile",
"custom": {}
},
"referrerCode": "<string>",
"guest": true
}
]
}
'{
"jobId": 123
}Create Customers Batch Job
The Batch Customer API allows clients to create or update multiple customer profiles in a single API call. This is useful for bulk user imports, mass profile updates, and large-scale customer data synchronization while reducing network overhead and improving efficiency.Authorizations
Body
Show child attributes
Show child attributes
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.
Customer's email address. Required if your account uses email-based channel merging.
Customer's mobile number. Required if your account uses mobile-based channel merging.
Token used to identify the device.
Operating system type of the device.
Additional customer-specific attributes. Includes attributes such as the customer's name, contact details, and purchase history.
Show child attributes
Show child attributes
Display name for the customer.
Customer's first name.
Customer's last name.
Customer's email address.
Customer's gender.
Customer's mobile number.
Customer's date of birth.
Date the customer joined.
Customer's country.
Customer's city.
Customer's postal code.
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.
Source of the customer registration.
List of UTM attributes associated with the customer.
List of devices associated with the customer.
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.
Total amount spent by the customer.
Date of the last order placed by the customer.
Total number of orders placed by the customer.
Average amount spent per order by this customer.
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.
mobile, pos, web, callcenter 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.
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.
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
Batch customer data processing initiated successfully
The assigned job ID, which is later used for status verification and response retrieval.
Was this page helpful?