---
title: "Update customer custom fields"
method: PATCH
path: "/v1/customers/{customerId}/custom-fields"
tags: ["Customers"]
---

# Update customer custom fields

`PATCH /v1/customers/{customerId}/custom-fields`

## Request

- Base URL: `https://api.workwing.io`
- URL: `https://api.workwing.io/v1/customers/{customerId}/custom-fields`
- Auth: HTTP bearer

Update custom field values on an existing customer using field_key slugs. Values are validated against each field's definition (type and required rules). Send `null` to clear a field; that deletes the stored value and needs the `delete:custom_field_values` scope.

## Path parameters

- `customerId` string, uuid, required

## Headers

- `Idempotency-Key` string, required

## Request body

- object
  - `custom_fields` object, required

## Response `200`

Default Response

- object
  - `data` object, required
    - `custom_fields` object, required: The entity's values keyed by field_key, typed as in the GET response. A field with no value is absent.
  - `meta` object, required
    - `request_id` string, required
    - `timestamp` string, date-time, required

---

[API](https://skmtc.dev/workwing/apis/workwing-api.md) · [All operations](https://skmtc.dev/workwing/apis/workwing-api/llms.txt) · [OpenAPI document](https://skmtc.dev/workwing/apis/workwing-api/revisions/54bb14368a35?raw)