post https://{host}/v1.1/customer/update
Let's you update the details of an existing customer other than primary or secondary identifiers. If any of the identifiers you pass already exists for a different account, then the customer details will be merged automatically.
Make sure you have the appropriate access control configured. For more information, see access group documentation.
API Behavior
- Updates existing customer details other than primary/secondary identifiers including custom fields and extended fields.
- Secondary identifiers only with null values will be updated. Hence, existing identifiers cannot be updated with this API.
You can update secondary identifiers (mobile no./email id./external id) only if the respective config mentioned in the following are enabled on InTouch Settings > Miscellaneous > Registration Configuration.
- CONF_ALLOW_MOBILE_UPDATE (for mobile number).
- CONF_ALLOW_EMAIL_UPDATE (for email id).
- CONF_LOYALTY_ALLOW_EXTERNAL_ID_UPDATE (for external id).
API endpoint
/v1.1/customer/update
Header information
You can define certain attributes in the API header section and define the user context details. For more information, refer to the user context section in the Audit Details documentation.
Body Parameters
| Parameter | Description |
|---|---|
| Mobile/email/external_id/id* | Pass any one of the following identifiers of the customer whose details you want to update. |
| firstname | First name of the customer. |
| lastname | Last name of the customer. |
| registered_on | Date on which the customer is registered. Format: YYYY-MM-DD HH:MM:SS, Example: 2016-09-11 11:11:11 |
| registered_till | The TILL at which customer is registered. |
| associated_with | Till code that you want to associate with the customer. |
| type | Pass LOYALTY to convert a non_loyalty customer to loyalty. You cannot change a loyalty customer non-loyalty (NON_LOYALTY). |
| custom_fields | Provide the custom field values of the customer in name and value pairs. You can only pass custom fields that are configured for the org. |
| extended_fields | Provide the extended field details of the customer in name and value pairs. You can only pass extended fields that are configured for the org. |
| subscriptions | Provide the subscription details of the customer. |
| priority | Type of message. Value: TRANS for personalized or transaction messages, BULK for promotional messages. |
| channel | Current communication channel. Value: sms, email. |
| fraud_status | Update the fraud status of the customer in status. Values: CONFIRMED, NONE. |
Response Parameters
| Parameter | Description |
|---|---|
| user_id | Unique ID of the customer generated by the system. |
| total | Number of customers passed for registration. |
| success_count | Number of customers that registered successfully. |
| lifetime_points | Total loyalty points earned by the customer to date. |
| lifetime_purchases | Total purchases amount (loyalty or non-loyalty transactions) of the customer across all stores of the org. |
| loyalty_points | Current active loyalty points (neither redeemed nor expired) of the customers. |
| current_slab | Current loyalty tier of the customer. |
| tier_expiry_date | Expiry date of the current tier in YYYY-MM-DD HH:MM:SS format. |
| points_summaries | Shows the details of the loyalty points. |
| programId | Unique ID of the loyalty program associated to the points summary. |
| redeemed | In total points earned from the program, the total number of points that are redeemed. |
| expired | In total points earned from the program, the total number of points that are expired. |
| returned | In total points earned from the program, the total number of points that are returned. Usually, for transaction returns. |
| adjusted | Points that are either credited to or debited from the customer account in adjustments. The value will be negative if debited points are more than credited, and positive if credited points are more than debited. |
| cumulativePurchases | Total purchases amount of the customer in the stores associated to the current loyalty program. |
| currentSlab | Current tier of the customer in the loyalty program. |
| nextSlab | Next loyalty tier of the customer. |
| nextSlabSerialNumber | Serial number of the next tier. Lowest tier will have 1, succeeding tier will have 2 and so on. |
| nextSlabDescription | Description of the next tier as saved in the loyalty program. |
| slabSNo | Serial number of the current tier of the customer. Lowest tier will have 1, succeeding tier will have 2 and so on. |
| slabExpiryDate | Expiry date of the current loyalty tier of the customer in YYYY-MM-DD HH:MM:SS. |
| registered_on | Date on which the customer is enrolled in the org's loyalty. |
| updated_on | Recent date on which the customer details are updated. |
| type | Loyalty type of the customer. LOYALTY if the customer is enrolled in the org's loyalty program, NON_LOYALTY if customer has not enrolled in the loyalty program but registered mobile number or email id with the org. |
| custom_fields | Custom field details of the customer - custom field name (name) and custom field value (value). |
| extended_fields | Extended field details of the customer - extended field name (name) and extended field value (value). |
| subscriptions | Mobile number and email ID subscription details of the customer. |
| channel | Subscription channel. Value: SMS, EMAIL. |
| priority | Type of subscription. Value: TRANS for transaction or personalized messages, BULK for campaign or promotion messages. |
| status | 0 for unsubscribed, 1 for subscribed. |
| side_effects | Other activities triggered because of the customer update. For example, points rewarded to the customer for updating profile (if configured). |