v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB

Workflows

Set new custom field values

Set new custom field values on a given entity.

🔒 Requires: custom_fields:write scope

post/workflows/custom_fields/values

entity'sale' | 'line_item' | 'customer' | 'product' required

The entity type.

entity_idstring uuid required

The ID of entity.

{
  "values": [
    {
      "name": "my_custom_field",
      "string_value": "spec-test-value"
    }
  ]
}

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

{
  "data": [
    {
      "definition_id": "1239349157873029120",
      "name": "my_custom_field",
      "title": "My Custom Field"
    }
  ]
}