/
Update Customer [PUT]

Update Customer [PUT]

Owned by David Garcerán
Last updated: Mar 26, 2024 by Jordi Artal

Operation

Updates a customer.

PUT
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/customer/{customerId}


Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter

customerIdIntegertruepath parameter
The customer to be updated

Example request

PUT https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/customer/508


Entity


FieldTypeRequiredDescription
idintfalseUnique identifier for the Customer.
namestringtrueName of the Customer.
customerDocumentListList of CustomerDocumenttrue
customerEmailListList of CustomerEmailfalse
customerAddressListList of CustomerAddressfalse
customerPhoneListList of CustomerPhonefalse
profileTypeProfileTypefalse
customerCustomFieldValueListList of CustomerCustomFieldValuefalse
customerLoyaltyListList of CustomerLoyaltyfalse
chainVipLevelchainVipLevelfalseOnly for get/list. Not for save/update/delete.

Body

The body that will be sent in the operation

{
  "id": 1321,
  "name": "Amanda Gösta Torres",
  "customerDocumentList": [
    {
      "id": 48,
      "primary": true,
      "documentType": {
        "id": 5,
        "code": "5",
        "name": "National identity document"
      },
      "number": "DOC 1",
      "givenName": "Amanda",
      "secondSurName": "Gösta",
      "surName": "Torres",
      "genderType": {
        "id": 1,
        "code": "M",
        "name": "Male"
      },
      "birthDate": "2000-01-01",
      "birthCountryCode": "ES",
      "birthPlace": "Augusta",
      "effectiveDate": "2015-06-15",
      "expireDate": "2020-01-01",
      "street": null,
      "city": null,
      "stateProvName": "Georgia",
      "stateProvCode": null,
      "countryCode": "TK",
      "postalCode": "30911",
      "nationalityCountryCode": "TK",
      "ocr": null,
      "remark": "Document Remark"
    }
  ],
  "customerEmailList": [
    {
      "id": 1323,
      "primary": true,
      "emailAddressType": {
        "id": 1,
        "code": "1",
        "name": "Personal"
      },
      "email": "atorresgu@clickbank.net",
      "remark": null
    }
  ],
  "customerAddressList": [
    {
      "id": 1288,
      "primary": true,
      "communicationLocationType": {
        "id": 1,
        "code": "1",
        "name": "Home"
      },
      "street": "95 Armistice Alley",
      "city": "Augusta",
      "stateProvName": "Georgia",
      "stateProvCode": null,
      "postalCode": "30911",
      "countryCode": "AU",
      "remark": "Address Remark"
    }
  ],
  "customerPhoneList": [
    {
      "id": 1323,
      "primary": true,
      "phoneLocationType": {
        "id": 6,
        "code": "6",
        "name": "Home"
      },
      "phoneTechType": {
        "id": 1,
        "code": "1",
        "name": "Voice"
      },
      "countryAccessCode": "+34",
      "areaCityCode": "B",
      "phoneNumber": "1-(706)821-6121",
      "extension": "1",
      "remark": "Phone Remark"
    }
  ],
  "remark": "Customer Remarks",
  "profileType": {
    "code": "1",
    "name": "Customer",
    "nameI18n": "Customer",
    "colorCode": "#00ACC1"
  },
  "customerProfileList": [
        {
            "allowMarketing": true,
            "allowThirdParty": false
        }
    ],
    "customerLoyaltyList": [
        {
            "id": 16,
            "chainLoyalty": {
                "id": 1,
                "programId": "IB",
                "name": "IberiaPlus",
                "propertyLoyaltyList": [
                    {
                        "id": 1,
                        "active": true,
                        "inactiveReason": null
                    } ...
                ]
            },
            "membershipId": "33333333333A"
        } ...
    ]
}

Response

PropertyTypeRequiredDescription
ResponseApiMessageResponseApiMessagetrueDescription of the response of the success operation

Example response

{
  "httpStatus": "201",
  "userMessage": "Success",
  "technicalMessage": "Success customer updated",
  "errorCode": "0",
  "id": 1321
}

Related content