dxp-ux

(0 reviews)

Patch-Customer

updateCustomer

PATCH

This operation list or find Customer entities.

URL

http://[localhost]:[port]/dxp-ux/v1/{businessId}/customer/{id}

Common Parameters
Base URI parameters and headers are common to all the resources as part of customer management Biz API, listed below with details.

Base URI Parameter

NameTypeM/ODescription
businessIdstringMBusiness unit identifier. PR is in scope.
idstringMcustomer id

Headers

namevaluedescriptionrequired
X-Correlation-IDstringThis is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers.
Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b
O
channeIdstringChannel to business:
Expected Value: "APP"
Note: default value is "APP"
M
lobStringEnum: PREPAID, POSTPAID,FIXED
Expected value : FIXED
Note: PREPAID OR POSTPAID FOR Matrixx
M

Security Headers

namevaluedescriptionrequired
client_idstringClient Id value for Client Id Enforcement policy. Environment Specific Value.
Eg:6f0ed16a7b494d76b2d60e05bc3b3332
M
client_secretstringClient secret value for Client Id Enforcement policy. Environment Specific Value
Eg: e4CD4D43449846aA9D8Cb9c43fAd324a
M

Note:

To update customer email address for Csg system need to pass lob as "FIXED"

To update customer details for aria , matrixx systems you need to pass lob as "PREPAID OR POSTPAID" and targetSystem as "ARIA OR MATRIXX"

Request

Sample request payload to update email address.

{
    "contactMedium": [
        {
            "mediumType": "Email",
            "characteristic": {
                "emailAddress": "test@gmail.com"
            }
        }
    ]
}
nametyperequireddescription
namestringOA word, term, or phrase by which the Customer is known and distinguished from other Customers.
contactMedium[]ArrayM
mediumTypestringMContact medium type. Eg: "Email"
CharacteristicObjectMDescribes a given characteristic of an object or entity through a name/value pair.
emailAddressstringMEmail address of customer. Updated only If value is present.

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - Sample response payload.

{
    "contactMedium": [
        {
            "mediumType": "Email",
            "characteristic": {
                "emailAddress": "test@gmail.com"
            }
        }
    ]
}
nametyperequireddescription
namestringOA word, term, or phrase by which the Customer is known and distinguished from other Customers.
contactMedium[]ArrayM
mediumTypestringMContact medium type. Eg: "Email"
CharacteristicObjectMDescribes a given characteristic of an object or entity through a name/value pair.
emailAddressstringMEmail address of customer. Updated only If value is present.

Reviews