Skip to main content
POST
Create an attribute definition

Authorizations

Authorization
string
header
required

Workspace-scoped API key. Available scopes:

  • read:products: List and read products, including variants, references, and completeness.
  • write:products: Create, update, and upsert products and their attribute values.
  • delete:products: Delete products.
  • read:images: List and read images.
  • write:images: Create, update, and upsert images and their attribute values.
  • delete:images: Delete images.
  • read:vendors: List and read vendors.
  • write:vendors: Create, update, and upsert vendors and their attribute values.
  • delete:vendors: Delete vendors.
  • read:categories: List and read categories.
  • write:categories: Create, update, and upsert categories and their attribute values.
  • delete:categories: Delete categories.
  • read:sources: List and read data sources, including scraped content.
  • write:sources: Create data sources (triggers processing) and update their attribute values.
  • delete:sources: Delete data sources.
  • read:attributes: List and read attribute definitions.
  • write:attributes: Create and update attribute definitions.
  • read:views: List and read saved grid views (MCP surface).
  • write:views: Create and update grid views (MCP surface).
  • read:channels: Read the enabled channel catalog.
  • read:events: Read the workspace change feed and per-entity events.
  • read:jobs: List and poll asynchronous job status.

Body

application/json

Create body (snake_case, like every write body). single_select_list/multi_select_list require acceptable_values.

name
string
required
entity_type
string
required
data_type
enum<string>
required
Available options:
single_line_text_field,
multi_line_text_field,
rich_text_field,
number,
boolean,
date,
url,
json,
single_select_list,
multi_select_list,
image,
video,
formula,
status,
progress,
rank
ai_generated
boolean
required
custom_instructions
string

Generation prompt; reference other attributes with {{key}}.

acceptable_values
string

Comma-separated allowed values for select attributes.

default_value
string
is_primary
boolean
selected_tools
enum<string>[]

AI text-generation tools. includeWebSearch = live web research; includeDataSources = scraped sites/CSVs; includeImages = vision.

Available options:
includeDataSources,
includeImages,
includeWebSearch,
includeProductAttributes
source_attribute_keys
string[]
required_dependencies
string[]
image_model
enum<string>
Available options:
gpt-image-1,
nano-banana
image_source_attribute_key
string[]
aspect_ratio
enum<string>
Available options:
Square,
Landscape,
Portrait
video_model
enum<string>
Available options:
veo3.1
video_source_attribute_key
string[]
vision_image_source_attribute_key
string[]
inheritance_mode
enum<string>

Parent/child variant inheritance (products only; ignored for image/video attributes). inherit_from_parent = variants display the parent's value; rollup_from_children = the parent displays its variants' combined values; off removes inheritance. Virtualized at read time.

Available options:
off,
inherit_from_parent,
rollup_from_children
rollup_aggregation
enum<string>

Only with rollup_from_children. unique = distinct values joined; all = one entry per variant. Default unique.

Available options:
unique,
all

Response

The created attribute definition (full config).

data
object

The full attribute-definition config returned by create/update — a superset of the discovery projection (raw acceptable_values string, generation tool, constraints).

Example: