How to update a customer

This document is designed to help you understand how you can update an existing customer, along with their communications, vehicles and addresses, using a given request body and customer UUID. To update a customer, you first need your credentials. If you don't already have them, head over to the Authentication and Authorization page to see how you can request credentials from us. The endpoint mentioned below can assist you in updating a customer by customizing the request body for the specified customer UUID:

Parameters

Path parameters

Parameter Name	Value	Description	Required
departmentUUID	String	Unique identifier of dealer department	Yes
customerUUID	String	Unique identifier used by mykaarma used for uniquely identifying customers over API calls	Yes

Authorization

Parameter Name	Description	Required
{{basic_auth_token}}	Authorization: Base64 encoded string using Service Subscriber Username and password	Yes

Scope

This request requires the following authorization scopes:

Scope	Level	Description
customer.update	DealerDepartment	Authorizes client to update customer for provided user's dealer department

Endpoint

curl -X PUT "https://api.mykaarma.com/customer/v2/department/{{departmentUUID}}/customer/{{customerUUID}}"
-H "Authorization: {{basic_auth_token}}"
-H "Content-Type: application/json"
-d '{
  "customer": {
    "customerKey": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "isBusiness": true,
    "addresses": [
      {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "zip": "string",
        "addressType": "string",
        "type": "Enum",
        "country": "string",
        "isValid": true,
        "isPreferred": true,
        "state": "string"
      }
    ],
    "preferredLocale": "string",
    "customerUuid": "string",
    "emails": [
      {
        "emailAddress": "string",
        "label": "string",
        "okToEmail": true,
        "isPreferred": true
      }
    ],
    "phoneNumbers": [
      {
        "phoneNumber": "string",
        "label": "string",
        "okToCall": true,
        "okToText": true,
        "isPreferred": true
      }
    ]
  },
  "vehicles": [
    {
      "vin": "string",
      "vehicleYear": "string",
      "vehicleMake": "string",
      "vehicleModel": "string",
      "estimatedMileage": "string",
      "vehicleKey": "string",
      "vehicleTrim": "string",
      "licensePlate": "string",
      "color": "string",
      "vehicleUuid": "string",
      "vehicleEngine": "string",
      "isValid": true
    }
  ],
  "validateVin": true
}'

Response

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ]
}

Request Body

This payload consists of myKaarma Customer object with Vehicles associated with it. You can find the field references for Customer and Vehicle in respective links.

Note

If a customer key passed in the request body already exists in myKaarma system for the given department for a different customer , then the customer update process will fail.

Response Object Explanation

{{errors}} An array of error objects detailing issues encountered during customer creation or update.

{{warnings}} An array of warning objects providing non-critical alerts encountered during customer creation or update.

{{errors.errorCode}} Code indicating the specific error encountered during customer creation or update; refer to the API reference for a list of possible error codes.

{{errors.errorTitle}} Title describing the specific error encountered during customer creation or update; refer to the API reference for detailed descriptions.

{{errors.errorMessage}} Detailed message describing the specific error encountered during customer creation or update; refer to the API reference for more information.