---
title: "Update information about a customer"
method: PATCH
path: "/customers/{customerId}"
tags: ["Customers"]
---

# Update information about a customer

`PATCH /customers/{customerId}`

## Request

- Base URL: `https://api.dojo.tech`
- URL: `https://api.dojo.tech/customers/{customerId}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/dojo/apis/dojo-api/docs/customers/:customerId/patch.ts> (a function with typed inputs; its response is checked against the schema)

Updates information about a customer.

## Path parameters

- `customerId` string, nullable, required

## Headers

- `version` string, nullable, required

## Request body

- UpdateCustomerRequest
  - `name` string, nullable: The customer's name.
  - `billingAddress` Address: Details about the address.
    - `address1` string, nullable: Address line 1 (for example, company name).
    - `address2` string, nullable: Address line 2 (for example, street, apartment, or suite).
    - `address3` string, nullable: Address line 3.
    - `address4` string, nullable: Address line 4.
    - `city` string, nullable: City, town, district, suburb, or village.
    - `state` string, nullable: State, province, or region.
    - `postcode` string, nullable: ZIP or postal code.
    - `countryCode` string, required: Two-letter country code in [ISO 3166–1-alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
    - `locality` string, nullable: Locality, can use in addition to city.
    - `county` string, nullable: County or zone.
  - `shippingAddress` Address: Details about the address.
    - `address1` string, nullable: Address line 1 (for example, company name).
    - `address2` string, nullable: Address line 2 (for example, street, apartment, or suite).
    - `address3` string, nullable: Address line 3.
    - `address4` string, nullable: Address line 4.
    - `city` string, nullable: City, town, district, suburb, or village.
    - `state` string, nullable: State, province, or region.
    - `postcode` string, nullable: ZIP or postal code.
    - `countryCode` string, required: Two-letter country code in [ISO 3166–1-alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
    - `locality` string, nullable: Locality, can use in addition to city.
    - `county` string, nullable: County or zone.
  - `emailAddress` string, nullable: The customer's email address.
  - `phoneNumber` string, nullable: The customer's phone number.
  - `vatNumber` string, nullable: The customer's VAT number.

## Response `200`

OK

- CustomerFull
  - `id` string, nullable: The unique identifier of the customer.
  - `name` string, nullable: The customer's name.
  - `shippingAddress` Address: Details about the address.
    - `address1` string, nullable: Address line 1 (for example, company name).
    - `address2` string, nullable: Address line 2 (for example, street, apartment, or suite).
    - `address3` string, nullable: Address line 3.
    - `address4` string, nullable: Address line 4.
    - `city` string, nullable: City, town, district, suburb, or village.
    - `state` string, nullable: State, province, or region.
    - `postcode` string, nullable: ZIP or postal code.
    - `countryCode` string, required: Two-letter country code in [ISO 3166–1-alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
    - `locality` string, nullable: Locality, can use in addition to city.
    - `county` string, nullable: County or zone.
  - `billingAddress` Address: Details about the address.
    - `address1` string, nullable: Address line 1 (for example, company name).
    - `address2` string, nullable: Address line 2 (for example, street, apartment, or suite).
    - `address3` string, nullable: Address line 3.
    - `address4` string, nullable: Address line 4.
    - `city` string, nullable: City, town, district, suburb, or village.
    - `state` string, nullable: State, province, or region.
    - `postcode` string, nullable: ZIP or postal code.
    - `countryCode` string, required: Two-letter country code in [ISO 3166–1-alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
    - `locality` string, nullable: Locality, can use in addition to city.
    - `county` string, nullable: County or zone.
  - `emailAddress` string, nullable: The customer's email address.
  - `phoneNumber` string, nullable: The customer's phone number.
  - `vatNumber` string, nullable: The customer's VAT number.
  - `createdAt` string, date-time, nullable: The creation date, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format.
  - `updatedAt` string, date-time, nullable: The timestamp of the update date, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format.
  - `documentVersion` integer: The version of the customer's data updated with every change.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `404`: Not found

---

[API](https://skmtc.dev/dojo/apis/dojo-api.md) - [All operations](https://skmtc.dev/dojo/apis/dojo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dojo/apis/dojo-api/revisions/29fc8900ba37?raw)