---
title: "Update a Customer"
method: PATCH
path: "/v1/customers/{customer_id}"
---

# Update a Customer

`PATCH /v1/customers/{customer_id}`

This API updates details of a customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

## Path parameters

- `customer_id` string, required

## Headers

- `Accept` string, required
- `Content-Type` string, required

## Request body

- object
  - `email` string — Email address of the customer. It is displayed next to the customer in the dashboard and can be used for searching and tracking.
  - `name` string — Name of the customer.
  - `description` string — An arbitrary string that you can attach to a customer. It is displayed next to the customer in the dashboard.
  - `send_email_address` string — Email address to which the invoices will be sent.
  - `cc_email_address` string — Email address to which the invoices will be sent.
  - `country` string — Customer's country name.
  - `address_1` string — The customer's address for line 1.
  - `address_2` string — The customer's address for line 2.
  - `city` string — The cutomer's city name. Can be a City/District/Suburb/Town/Village.
  - `state` string — The customer's state name. Can be State/County/Province/Region.
  - `zip` integer — The customer's ZIP code.
  - `phone` integer — The customer's phone number.
  - `token_id` string — The token issued by the token service provider. A token is generated to represent the credit card number.
  - `default_card_id` string — ID of the customer's card that should be set as default.

## Response `200`

200

- object
  - `data` object
    - `object` string
    - `customer_id` string
    - `name` string
    - `email` string
    - `description` string
    - `payment_overdue` integer
    - `send_email_address` string
    - `cc_email_address` string
    - `source_id` unknown
    - `address_1` string
    - `address_2` string
    - `city` string
    - `state` string
    - `zip` string
    - `phone` string
    - `country` string
    - `created_at` integer
    - `updated_at` integer
    - `readable_created_at` string
    - `readable_updated_at` string
    - `invoice_prefix` string
    - `card` object
      - `data` unknown[]
        - unknown
    - `bank_account` object
      - `data` unknown[]
        - unknown
  - `meta` object
    - `include` string[]
    - `custom` unknown[]
      - unknown

## Other responses

- `500` — 500

---

[API](https://skmtc.net/payarc/apis/payarc-sandbox.md) · [All operations](https://skmtc.net/payarc/apis/payarc-sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payarc/payarc-sandbox/versions/face82bdd778/schema)
