Update a custom field definition - Spree Commerce documentation

PATCH

api

admin

custom_field_definitions

{id}

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const definition = await client.customFieldDefinitions.update('cfd_UkLWZg9DAJ', {
  label: 'Country of Origin',
  storefront_visible: false,
})

{
  "id": "cfdef_UkLWZg9DAJ",
  "namespace": "specs",
  "key": "fabric",
  "label": "Fabric Composition",
  "field_type": "short_text",
  "resource_type": "Spree::Product",
  "storefront_visible": false,
  "created_at": "2026-06-17T13:36:33.482Z",
  "updated_at": "2026-06-17T13:36:33.784Z"
}

Authorizations

x-spree-api-key

string

header

required

Secret API key for admin access

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Path Parameters

string

required

Body

application/json

label

string

storefront_visible

boolean

Response

200 - application/json

definition updated

Delete a custom field definition

List customer groups

⌘I

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const definition = await client.customFieldDefinitions.update('cfd_UkLWZg9DAJ', {
  label: 'Country of Origin',
  storefront_visible: false,
})

{
  "id": "cfdef_UkLWZg9DAJ",
  "namespace": "specs",
  "key": "fabric",
  "label": "Fabric Composition",
  "field_type": "short_text",
  "resource_type": "Spree::Product",
  "storefront_visible": false,
  "created_at": "2026-06-17T13:36:33.482Z",
  "updated_at": "2026-06-17T13:36:33.784Z"
}