---
title: "Update a customer"
method: POST
path: "/v3/merchants/{mId}/customers/{customerId}"
tags: ["CUSTOMERS"]
---

# Update a customer

`POST /v3/merchants/{mId}/customers/{customerId}`

Updates information for a single customer.

## Path parameters

- `mId` string, required
- `customerId` string, required

## Query parameters

- `expand` string

## Headers

- `User-Agent` string, required

## Request body

- object
  - `id` string — Unique identifier.
  - `merchant` object — Merchant with which the customer is associated.
    - `id` string — Unique identifier of the merchant.
  - `firstName` string — First name of the customer. Length: Maximum 64 characters
  - `lastName` string — Last name of the customer. Length: Maximum 64 characters
  - `marketingAllowed` boolean — Indicates whether the customer allows marketing communication from Clover. **Note:** This function is only allowed for Clover internal apps, and third-party apps should receive marketing opt-in from customers per their local laws and store consent in their own systems.
  - `customerSince` integer — Date since when the customer is associated with the merchant.
  - `orders` object[] — Customer's orders.
    - `id` string — Unique identifier of the order.
  - `addresses` object[] — Customer's mailing and shipping address. This information is displayed on invoices emailed to the customer. Note: Address must contain a value. Length: Maximum 127 characters
    - `address1` string — Line 1 of the customer's street address.
    - `address2` string — Line 2 of the customer's street address.
    - `address3` string — Line 3 of the customer's street address.
    - `city` string — Customer's city.
    - `country` string — Customer's country.
    - `state` string — Customer's state.
    - `zip` string — Postal code of the customer's address.
  - `emailAddresses` object[] — Customer's email address.
    - `id` string — Unique identifier.
    - `emailAddress` string, required — Email address of the customer. Note: A valid email address is required. . Email address domains are validated using the [Apache Domain Validator](https://commons.apache.org/proper/commons-validator/apidocs/org/apache/commons/validator/routines/DomainValidator.html). . Customer email addresses are validated using the [Apache Email Validator](https://commons.apache.org/proper/commons-validator/apidocs/org/apache/commons/validator/routines/EmailValidator.html).
    - `verifiedTime` integer — Time when the system verified the customer's email address as valid.
    - `primaryEmail` boolean — Customer's primary email address.
    - `customer` object — Customer name associated with the email address.
      - `id` string — Unique identifier of the customer.
  - `phoneNumbers` object[] — Customer phone numbers.
    - `id` string — Unique identifier.
    - `phoneNumber` string, required — Customer's phone number.
    - `customer` object — Customer name associated with the phone number.
      - `id` string — Unique identifier of the customer.
  - `cards` object[] — Customer card details.
    - `id` string — Unique identifier.
    - `first6` string, required — First 6 digits of the customer's card.
    - `last4` string, required — Last 4 digits of the customer's card.
    - `firstName` string — First name on the customer's card.
    - `lastName` string — Last name on the customer's card.
    - `expirationDate` string — Expiry date of the customer's card.
    - `additionalInfo` object — Additional information for the customer's card.
      - `default` string
    - `cardType` string — Customer's card type.
    - `token` string — Customer's card token number. Length: Maximum 72 characters
    - `tokenType` 'MULTIPAY' | 'FINANCIAL' | 'CTOKEN' — Customer's card token type.
    - `modifiedTime` integer — Time when the card was last updated.
    - `customer` object — Customer to whom the card belongs.
      - `id` string — Unique identifier of the customer.
  - `metadata` object — Additional information about the customer.
    - `businessName` string — Name of the business. Length: Maximum 127 characters
    - `note` string — Additional information about the customer. Length: Maximum 2000 characters
    - `dobYear` integer — Optional. Year of the customer’s date of birth.
    - `dobMonth` integer — Month of the customer’s date of birth.
    - `dobDay` integer — Day of the customer’s date of birth.
    - `modifiedTime` integer — Time when the customer record was last updated.
    - `customer` object — Customer for whom the metadata is saved.
      - `id` string — Unique identifier of the customer.

## Response `200`

Successful response. Customer record updated.

- object
  - `id` string — Unique identifier of the customer.
  - `firstName` string — First/given name of the customer. Length: Maximum 64 characters
  - `lastName` string — Last name/surname of the customer. Length: Maximum 64 characters
  - `marketingAllowed` boolean — Indicates whether the customer allows marketing communication from Clover. **Note:** This function is only allowed for Clover internal apps, and third-party apps should receive marketing opt-in from customers per their local laws and store consent in their own systems.
  - `customerSince` integer — Date of start of customer association with the merchant.
  - `metadata` object — Additional information about the customer.
    - `businessName` string — Name of customer's business. Length: Maximum 127 characters
    - `note` string — Additional information about the customer. Length: Maximum 2000 characters
    - `dobYear` integer — Optional. Year of the customer’s date of birth.
    - `dobMonth` integer — Month of the customer’s date of birth.
    - `dobDay` integer — Day of the customer’s date of birth.
    - `modifiedTime` integer — Time when the customer data was last updated.
    - `customer` object — Customer for whom the metadata is saved.
      - `id` string — Unique identifier of the customer.

---

[API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/versions/08da265101a3/schema)