Skip to main content
POST
Create Product Custom Field
Creates a new custom field definition for catalog products.

Options requirement

When setting field_type to dropdown or multi_select, you must supply an array of allowed values in the options property.

Required permissions

Requires an API key with the crm:write scope.

Authorizations

x-api-key
string
header
required

Workspace API key header. The key implicitly determines your workspace isolation. Scopes: crm:read for GET/HEAD/OPTIONS, crm:write for POST/PATCH/PUT/DELETE.

Body

application/json
field_name
string
required
Example:

"Partner Tier"

field_key
string
required
Example:

"partner_tier"

field_type
enum<string>
required
Available options:
text,
number,
date,
dropdown,
multi_select
Example:

"dropdown"

options
string[]

Required when field_type is dropdown or multi_select

Example:
is_required
boolean
default:false
Example:

false

Response

Product custom field created successfully

Standard envelope returned by POST, PATCH, PUT, and DELETE (mutation) endpoints

success
boolean
required
Example:

true

data
object
required

The created or updated entity

error
null
required
Example:

null