Update an attribute definition
API Reference
Update an attribute definition
Identified by the path key + entity_type in the body. Provide only the fields to change; array fields replace wholesale.
PATCH
Update an attribute definition
Authorizations
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.
Path Parameters
The attribute key.
Body
application/json
Update body — the attribute is identified by the path key + entity_type. Only provided fields change; array fields replace wholesale. Accepts the same config fields as create (all optional except entity_type).
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 Available options:
includeDataSources, includeImages, includeWebSearch, includeProductAttributes Available options:
gpt-image-1, nano-banana Available options:
Square, Landscape, Portrait Available options:
veo3.1 Available options:
off, inherit_from_parent, rollup_from_children Available options:
unique, all Response
The updated attribute definition (full config).
The full attribute-definition config returned by create/update — a superset of the discovery projection (raw acceptable_values string, generation tool, constraints).
Example: