---
title: "Update Client"
method: PATCH
path: "/v1/clients/{id}"
---

# Update Client

`PATCH /v1/clients/{id}`

This API endpoint updates a specific client.  <br><br> This PATCH request will only update the fields you specify (including custom fields), leaving the rest as they were. <br><br>Please note that for multi-select (tag) custom fields, all custom field options (tag values) must be included, the PATCH request will not preserve existing custom field options (tags).

## Path parameters

- `id` string, required

## Query parameters

- `sendInvite` boolean

## Request body

- object
  - `givenName` string — The client's given name.
  - `familyName` string — The client's family name.
  - `companyId` string — The ID of the company to assign this client to. This will replace the current companies that the client is assigned to.
  - `customFields` string, json — The key is the custom field’s key, and the value is either an array of option keys (for multi-select fields) or a direct value for all other types. You can clear a field by passing an empty string (or empty array for multi-select); omitting the field leaves it unchanged.

## Response `200`

200

- object
  - `id` string
  - `object` string
  - `createdAt` string
  - `givenName` string
  - `familyName` string
  - `email` string
  - `companyId` string
  - `companyIds` string[]
  - `status` string
  - `fallbackColor` string
  - `inviteUrl` string
  - `avatarImageUrl` string
  - `firstLoginDate` string
  - `lastLoginDate` string
  - `customFields` object
    - `phoneNumber` string
    - `tags` string[]
    - `address` object
      - `country` string
      - `region` string
      - `postalCode` string
      - `addressLine1` string
      - `addressLine2` string
      - `city` string
      - `fullAddress` string
  - `creationMethod` string
  - `updatedAt` string

---

[API](https://skmtc.net/assembly/apis/core-resources.md) · [All operations](https://skmtc.net/assembly/apis/core-resources/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/assembly/core-resources/versions/28a9e7d13a8c/schema)