Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update Customer Details

Lets you update customer details using the registered identifiers of the customer.

put/customers/lookup

Query parameters

source'FACEBOOK' | 'WEB_ENGAGE' | 'WECHAT' | 'INSTORE' | 'MARTJACK' | 'TMALL' | 'TAOBAO' | 'JD' | 'ECOMMERCE' | 'WEBSITE' required

Source in which you want to update customer identifier(s). For sources that support multiple accounts, you also need to provide the associated account id.

accountIdstring

Account for which you want to update the customer identifier (Required only for sources with multiple accounts)

use_asyncboolean

Pass true to run loyalty activities in the background, side effects will not be returned in the API response. If false, API will wait for Loyalty activities to complete and then respond to the client with side effects in the API response.

identifierName'mobile' | 'email' | 'externalId' | 'cardnumber' | 'cardExternalId' | 'wechat' | 'martjackId' | 'fbId' required

Identifier used to identify the customer.

identifierValuestring required

Value of the specified identifier.

Headers

X-CAP-API-OAUTH-TOKENstring

Response

200

createdIdinteger

Example response

{
  "createdId": 342963216,
  "sideEffects": [
    {
      "awardedPoints": 25,
      "type": "points"
    }
  ]
}