API Documentation

Add Customer

post
https://{host}/v2/customers

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

Pass true to get complete details of incentives such as awardOn, expiryDate, strategyIds and so on. See rawSideEffects in response for more details.

boolean
Defaults to false

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.

string
enum

Source in which the customer needs to be added.

string

Specific account ID of the source. Required for sources with multiple accounts.

Body Params
json
Headers
string
boolean

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.

boolean

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.

string

If required, add entity information of the user who is adding or updating this info.

string

Enter user ID

string

Enter user source.

string

Enter user source ID.

Responses

Updated about 1 month ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago