Create matrix Category Level Attribute (CLA) and schedule propagation task.

Handles matrix attribute definitions only - for simple definitions use POST /catalogs/nodes/{id}/attributes/{attributeDefinitionId} - and fails when the category already has this
attribute definition as a CLA; change the existing values with PUT /catalogs/nodes/{id}/attributes/{attributeDefinitionId}/matrix instead. An attribute inherited from a parent
category does not count as assigned here, so the call succeeds and creates an assignment on this category that
overrides the inherited one.

The attribute is stored on the category immediately, while copying its values onto products runs as a background
task. That task covers the products in this category; the products in its sub-categories are reached only once
propagation is switched on for this attribute, which is off on a newly created CLA - switch it on, as well as
mandatory, with PATCH /catalogs/nodes/{id}/attributes/{attributeDefinitionId}; the lock flag is not supported
for matrix definitions. The task ID is returned in the Resource-Id response header and Location points at
GET /async/status/{taskId}, which reports whether the propagation has finished.

A request body is always required, including when the attribute is attached with no values set - send
{"matrix": {}} in that case. The keys inside matrix are the column value IDs and, one level deeper, the
row value IDs taken from the definition's restriction, read with GET /definitions/{attributeDefinitionId};
column and row names are rejected.

For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help
pages Category Level Attributes (CLA).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID for the catalog node/category.

Example: 634c26e14cedfd0001775e9f

string
required

The ID for the attribute definition.

Example: 634c26e14cedfd0001775e9e

Query Params
boolean
Defaults to false

Controls what the propagation task does with the products it reaches that already have a value
for this attribute:

false = Keep the existing product values and fill in only the empty ones. This is the default when the
parameter is omitted.

true = Overwrite the existing product values with the value of this Category Level Attribute (CLA).

Warning: true replaces values on every product the propagation reaches - the products in this category,
and the products in all of its sub-categories as well once propagation is on for this attribute - including
values entered on individual products by hand, however many products that is. The propagation runs in the
background and cannot be undone: setting the flag back to false only changes later propagations, and
restoring the replaced values means setting them again product by product. Send true only when replacing the
existing product values is what was explicitly asked for.

Body Params

The matrix values for the new Category Level Attribute (CLA). The body is mandatory - send
{"matrix": {}} to attach the attribute with every cell left empty.

Example: {"matrix": {"634c26e14cedfd0001775ea0": {"634c26e14cedfd0001775ea1": "12 V"}}}

matrix
object | null

Value per cell, keyed first by the column value ID and then by the row value ID, both taken from the attribute
definition's restriction. IDs that do not belong to the definition are rejected; cells left out stay empty. The
matrix key itself must always be present - send an empty object {} to attach the attribute with every cell
left empty.

Headers
string

Specifies the context in which to operate. If omitted, the default context en is used.

In Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

Note: The default context is identified by the ID "en". IDs for additional contexts begin with a lowercase "L", not with the digit "1", followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.

Responses
202

Accepted

The request has been accepted for processing, but the processing has not been completed.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json