v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update customer details

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.

put/customer/update

Query parameters

format'json' | 'xml'

Request body

X-CAP-DIRECT-REPLAYstring

Pass true to add the customer but enable loyalty events to be executed at a later point of time. The events will be pushed to queue and will be executed in near real-time.

USER-CONTEXT-ENTITY-TYPEstring

If required, add entity information of the user who is adding or updating this info.

USER-CONTEXT-ENTITY-IDstring

Enter user ID

USER-CONTEXT-ENTITY-SOURCEstring

Enter user source.

USER-CONTEXT-ENTITY-SOURCE-IDstring

Enter user source ID.

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": 200,
      "message": "Success",
      "total": "1",
      "success_count": "1"
    },
    "customers": {
      "customer": [
        {
          "user_id": 173035394,
          "firstname": "Ritta",
          "lastname": "James",
          "mobile": "44700900015",
          "email": "test5@test.com",
          "external_id": "6420102700000035",
          "lifetime_points": 550,
          "loyalty_points": 500,
          "current_slab": "Member Tier ",
          "tier_expiry_date": "2121-11-16 23:59:59",
          "points_summaries": {
            "points_summary": [
              {
                "programId": "469",
                "redeemed": "0",
                "expired": "50",
                "returned": "0",
                "adjusted": "0",
                "lifetimePoints": "550",
                "loyaltyPoints": "500",
                "cumulativePurchases": "0",
                "currentSlab": "Member Tier ",
                "nextSlab": "Silver Tier",
                "nextSlabSerialNumber": "2",
                "nextSlabDescription": "Tier 2",
                "slabSNo": "1",
                "slabExpiryDate": "2121-11-16 23:59:59"
              }
            ]
          },
          "registered_on": "2012-09-11 11:11:15",
          "updated_on": "2019-12-09 14:59:49",
          "type": "LOYALTY",
          "source": "instore",
          "fraud_status": "NONE",
          "extended_fields": {
            "field": [
              {
                "name": "gender",
                "value": "Male"
              }
            ]
          },
          "subscriptions": {
            "subscription": [
              {
                "channel": "SMS",
                "priority": "BULK",
                "scope": "ALL",
                "status": "1"
              }
            ]
          },
          "item_status": {
            "success": "true",
            "code": "1000",
            "message": "Customer successfully updated",
            "warnings": {
              "warning": [
                "91017"
              ]
            }
          }
        }
      ]
    }
  }
}