Add Customer

Registers customers in the org’s loyalty program with the primary identifier (mobile number/email id/external id).


Make sure you have the appropriate access control configured. For more information, see access group documentation.

API Behaviour

  • If CONFIG_SKIP_SECONDARY_ID_ON_PRIMARY_MISMATCH is enabled, if the primary identifier is different but any of the secondary identifiers exist, a new customer is registered with the primary identifier ignoring the secondary identifier. The config is available on the Registration Page of InTouch Profile > Organization Settings > Miscellaneous.
    • Also, this config overrides CONF_PRIMARY_IDENTIFIER_STRICT_CHECK.
  • Adds custom field details.
  • Adds extended field values.

API endpoint


Body Parameters

The mandatory attributes for customer registration depend on the configurations set on InTouch Settings > Registration Configuration. You need to know your org configurations before using this API.

mobile**The mobile number of the customer. Note: For mobile numbers, add the mobile number with the country code.
email**The email address of the customer
external_id**An external identifier for the customer
firstnameThe first name of the customer
lastnameThe last name of the customer
updated_onThe date and time the customer was last updated
registered_tillThe registration validity of the customer
associated_withWhat or whom the customer is associated with
typeThe type of customer
fraud_statusThe fraud status of the customer
City_name (custom field)The city where the customer resides
address (custom field)The address of the customer
bde_mobile_number (custom field)The mobile number of the BDE associated with the customer
bde_name (custom field)The name of the BDE associated with the customer
firm_name (custom field)The name of the firm associated with the customer
club (custom field)The club associated with the customer
pincode (custom field)The pin code of the customer's address
pwgConsumption (custom field)The PWG consumption status of the customer.
state (custom field)The state where the customer resides.
profile_image_name (custom field)The name of the customer's profile image file.



To add a customer, you must provide at least one of the parameters marked with **

Response Parameters

status.successIndicates the success of the operation
status.codeThe code representing the status of the operation
status.messageThe message describing the status of the operation
status.totalThe total count in the response
status.success_countThe count of successful operations
customer.user_idThe unique identifier for the customer
customer.firstnameThe first name of the customer
customer.lastnameThe last name of the customer
customer.mobileThe mobile number of the customer
customer.emailThe email address of the customer
customer.external_idAn external identifier for the customer
customer.lifetime_pointsThe total lifetime points accumulated by the customer
customer.loyalty_pointsThe current loyalty points of the customer
customer.current_slabThe current slab of the customer in the loyalty program
customer.tier_expiry_dateThe expiry date of the customer's current tier
points_summary.programIdThe ID of the program associated with the points summary
points_summary.redeemedThe number of points redeemed
points_summary.expiredThe number of points expired
points_summary.returnedThe number of points returned
points_summary.adjustedThe number of points adjusted
points_summary.lifetimePointsThe lifetime points in the summary
points_summary.loyaltyPointsThe loyalty points in the summary
points_summary.cumulativePurchasesThe cumulative purchases in the summary
points_summary.currentSlabThe current slab in the points summary
points_summary.slabSNoThe serial number of the slab
points_summary.slabExpiryDateThe expiry date of the slab
customer.lifetime_purchasesThe total lifetime purchases made by the customer
customer.registered_onThe date and time when the customer registered
customer.updated_onThe date and time when the customer's information was last updated
customer.typeThe type of customer
customer.sourceThe source through which the customer was acquired
customer.fraud_statusThe fraud status of the customer
customer.reasonThe reason field (not populated in this response)
item_status.successIndicates the success of the customer item operation
item_status.codeThe code representing the status of the customer item operation
item_status.messageThe message describing the status of the customer item operation
item_status.warnings.warningWarning codes associated with the operation
Click Try It! to start a request and see the response here!