v1
latestOpenAPI 3.0.12026-07-24501176.6 MBAdd Customer
Lets you register customers in the org’s loyalty program or just register their identifiers across sources such as InStore, Facebook,Webengage, WeChat, Martjack, TMall, Taobao, JD, ecommerce, Line, Website, and Mobile app. You can also add customer-level extended and custom field details.
You can also issue loyalty card to the customer using this API.
Query parameters
Pass true to get complete details of incentives such as awardOn, expiryDate, strategyIds and so on. See rawSideEffects in response for more details.
Pass true to enroll a customer in all the loyalty programs available for the org. Pass false to enroll in a specific program or the default program of the till.
Source in which the customer needs to be added.
Specific account ID of the source. Required for sources with multiple accounts.
Headers
Pass true to wait for the loyalty activities to complete and then respond to the client with side effects in the API response; pass false to run Loyalty activities in the background. No side effects are returned in the API response.
Pass true to add the customer but enable loyalty events to be executed at a later point of time. The events will be pushed to queue and will be executed in near real-time.
If required, add entity information of the user who is adding or updating this info.
Enter user ID
Enter user source.
Enter user source ID.
Request body
Response
200
Example response
{
"createdId": 130713699,
"sideEffects": [
{
"awardedPoints": 100,
"type": "points"
}
]
}