post https://{host}/v2/customers//changeIdentifier
Lets you add/remove identifiers or loyalty cards of a registered customer across sources. You can also issue card to a customer.
Use Case - loyalty cards of a customer across sources can be added or removed.
Identifiers: mobile
, email
, externalId
, wechat
, martjackId
, fbId
, tmall_uname
, cuid
, ali_uname
, jd_uname
, vip_uname
, line
.
Limitations of the customer identifier update API:
- Only identifiers can be updated using this API
- Identifiers should be unique within a source for single account sources and unique within an account for multiple account sources.
- If an identifier that you add already exists in a different source/account, the account will be automatically merged into the existing account maintaining different entries of each source. The new account will be a victim account and the existing account is a survivor account.
Prerequisites
- Valid customer identifier(s) that you want to add to the existing account
The new identifier that you want to update should be unique across the source (for sources with single accounts) and unique across the account (for sources with multiple accounts).
Request Body Parameters
Parameters | Data Type | Description |
---|---|---|
add ** | Object | New identifier to add to the existing account. Pass as key-value pair. Example: { "type": "wechat", "value": "TS11" } . |
remove ** | Object | Existing identifier to remove from the account. Example: { "type": "email", "value": "[email protected]" } . |
type * | Enum | Type of identifier to add or remove. Supported values: cardnumber , email , mobile , wechat . |
value * | String | Value of the specified type . For cardnumber , enter a valid card number. For email, pass the email ID. More info on adding cards here. |
seriesId | Integer | Card series ID to which the card belongs (applicable when type is cardnumber ). |
statusLabel * | String | New custom status label for the card. Must match a predefined status label. Required for card issuance. |
API Specific Error Code
Error Code | Description | Reason |
---|---|---|
8015 | Customer not found for the given identifiers | No customer found with the given details. |