---
title: "Set new custom field values"
method: POST
path: "/workflows/custom_fields/values"
tags: ["Workflows"]
---

# Set new custom field values

`POST /workflows/custom_fields/values`

Set new custom field values on a given entity.

🔒 Requires: `custom_fields:write` scope

## Request body

- CustomFieldValuesParams — The parameters that can be passed to the set custom field values API.
  - `entity` 'sale' | 'line_item' | 'customer' | 'product', required — The entity type.
  - `entity_id` string, uuid, required — The ID of entity.
  - `values` object[], required — The values.
    - `boolean_value` boolean
    - `integer_value` integer
    - `name` string, required — The name of the custom field to set a value for. Must match an existing custom field name for the entity type.
    - `string_value` string, required

## Response `200`

A list of all the custom field values associated with the entity.

- CustomFieldValueCollection — The fields returned by the custom field value list API.
  - `data` CustomFieldValue[], required — An array of Custom Field Values.
    - `boolean_value` boolean
    - `definition_id` string — The ID of the custom field definition associated with this value.
    - `integer_value` integer
    - `name` string
    - `string_value` string
    - `title` string
    - `type` 'string' | 'integer' | 'boolean' | 'date' — The type of the value to be stored using this custom field.

---

[API](https://skmtc.net/lightspeedhq/apis/api-2026-07.md) · [All operations](https://skmtc.net/lightspeedhq/apis/api-2026-07/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightspeedhq/api-2026-07/revisions/72d4ceb46dbb/schema)