Skip to content
Omniglass Omniglass Omniglass

Declare a property on a product

PUT
/products/{id}/properties/{property}
 
curl --request PUT \
  --url https://example.com/api/v1/products/boreal-edge-55/properties/example \
  --header 'Content-Type: application/json' \
  --data '{ "default_value": "example", "required": true }'

Declares a catalog property on a custom product, or revises the declaration in place (the line is addressed by name, so the write is idempotent). Official products are read-only (422); an unknown product is a 404 and a property the catalog does not know is a 422. Gated by product:update.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required

The product, by name or uuid

string

The product, by name or uuid

property
required

The property name

string

The property name

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
default_value

The contract default, validated against the property’s data_type; omit for no default

required

Whether every instance of this product must set the property; defaults to false

boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
default_value

The contract default, shape given by the property’s data_type; omitted when the contract sets none

property_type_id
required

The catalog property’s uuid, the stable form of property_type_name

string
property_type_name
required

The catalog property this product declares

string
required
required

Whether every instance of this product must set the property

boolean
Example 
{
  "$schema": "/api/v1/schemas/ProductPropertyBody.json"
}

default

Section titled “default ”

Error

Media type application/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
Example 
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}