Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update Customer Details

Lets you update existing customer details.

put/customers/{userId}

Path parameters

userIdstring required

Unique ID of the customer whose information needs to be updated.

Query parameters

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

Source in which you want to update the customer details. For sources with multiple accounts such as WECHAT, FACEBOOK, MOBILE_APP, or LINE, you also need to provide the respective account id.

accountIdstring

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

use_asyncboolean

Pass true to run loyalty activities in the back ground. Hence, sideEffects are not returned in the response. Pass false to wait for loyalty activities to complete and return the side effects.

mlp_single_enrollboolean

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.

Headers

X-CAP-API-OAUTH-TOKENstring
USER-CONTEXT-ENTITY-TYPEstring

USER-CONTEXT-ENTITY-TYPE

USER-CONTEXT-ENTITY-IDstring

Enter user ID

USER-CONTEXT-ENTITY-SOURCEstring

Enter user source.

USER-CONTEXT-ENTITY-SOURCE-IDstring

Enter user source ID.

Request body

RAW_BODYstring json

Response

200

createdIdinteger

Example response

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