Docs API Reference Product Parameter/bff/product-parameter/update

/bff/product-parameter/update

Updates properties of an existing parameter definition. Only provided fields are changed. Changing the type does not automatically migrate existing product assignments.

Product ParameterpostBffProduct-parameterUpdate

Parameters

JSON body

Request body

application/json

codestringRequired

Code of the parameter to update.

Exampleweight

namestringOptional

New display name.

ExampleNet Weight

groupCodestring | nullOptional

One of 2:

Variant 1

string

New group code, or null to ungroup the parameter.

Exampletechnical-specs

Variant 2

null

type"string" | "number" | "boolean" | "enum" | "color"Optional

Parameter data type. "string" = free text, "number" = numeric with optional unit, "boolean" = true/false, "enum" = predefined list of values, "color" = predefined colors with hex codes.

unitstring | nullOptional

One of 2:

Variant 1

string

New unit label, or null to clear.

Exampleg

Variant 2

null

filterablebooleanOptional

New filterable flag.

comparablebooleanOptional

New comparable flag.

variantFormingbooleanOptional

New variant-forming flag.

multiValuebooleanOptional

New multi-value flag.

positionnumberOptional

New sort order position.

Example1

activebooleanOptional

New active status.

Exampletrue

Response schema

1 status code documented

200Success

successbooleanRequired

Whether the parameter was updated.

Response example

application/json

{
  "success": false
}

Request example

POST /bff/product-parameter/update

post

curl -X POST "https://api.bizkithub.com/bff/product-parameter/update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "weight",
  "name": "Net Weight",
  "filterable": false,
  "comparable": false,
  "variantForming": false,
  "multiValue": false,
  "position": 1,
  "active": true
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key