This guide shows you how to enable updating customer contact information by implementing the Update Customer Contact Information REST API endpoint and Customer Profile Update Notification.

Use Case

Your customer wants to update the email address using My account functionality.

1. The customer opens My Account functionality on your website.
2. The page has options for the customer to enter the following types of information:

• Billing contact
• Delivery contact
• Licensee contact

3. The customer enters information for the billing contact and clicks Submit.
   The page uses the Update Contact API endpoint to update the customer's billing information in the Cleverbridge platform.

4. Customer contact is updated in the database.
5. Cleverbridge sends you a notification which contains information with the customer's updated contact information.

Implement Update Customer Contact endpoint

Before you start

Make sure that:

• The customer has a subscription.
• At least one of the subscription products has the status Active.

Parameters

To achieve this particular use case, set the parameters in the Update Contact API call to the values listed in the table.

Step 1: Change contact information

If a customer would like to change their personal information (e.g., a new email address), call the Update Contact API endpoint. In the API call, do the following:

• Add the customer's CountryId and LanguageId to the Contact argument, as well as the contact information that they would like to update or change.
• Submit the ContactType to which you would like the changes to be applied.

• cURL

  curl --request POST \
    --url https://rest.cleverbridge.com/subscription/updatecontact \
    --header 'accept: application/json' \
    --header 'content-type: application/json' \
    --header 'authorization: Basic xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
    --data '{
      "Contact":{
        "CountryId":"US",
        "Email":"[email protected]",
        "LanguageId":"en"
      },
      "ContactType":"BillingContact"
      }'
      
  

Step 2: Cleverbridge sends you a notification

Cleverbridge sends you a CustomerProfileUpdateNotification, which contains information that allows you to update your local ecosystem (CRM, ERP, etc.).

It includes:

{
  "meta": {
    "type": "CustomerProfileUpdateNotification",
    "date": "2019-03-19T14:47:34.857671",
    "schemaUrl": "https://www.cleverbridge.com/JsonNotificationSchemas/CustomerProfileUpdateNotification"
  },
  "customer": {
    "customerId: "123456789",
    "internalCustomer": "UUID-YOUR-UNIQUE-ID-1234-5678",
    "billingContact": {
      ...
      "email": "[email protected]"
    },
    ...
    }
  }
}