Update the value or the propagation, lock and mandatory flags of a Category Level Attribute (CLA) and schedule propagation task.

At least one of attributeValue, copyAttribute, locked and mandatory must be sent. This is the only
operation that sets the three flags, whatever the definition type: copyAttribute switches propagation on, so
that the attribute and its value travel down to the sub-categories and their products; locked requires the
products in the category to keep the CLA value; mandatory requires them to have a value at all.

Works both on an attribute assigned to this category and on one inherited from a parent category - updating an
inherited attribute creates an assignment on this category that overrides it. Column, matrix and dictionary
values cannot be changed here; use the /column, /matrix or /dictionary/values variants of this path for
those.

Fails when the attribute definition is assigned neither on this category nor on any of its parents, when a flag
being sent was switched on by a parent category, when locked is sent for a column, matrix or compound
definition, or when forceCla is combined with a compound definition. When a parent category has locked the
attribute, a sent value is ignored without an error.

The change is stored on the category immediately, while applying it to products runs as a background task. That
task covers the products in this category, and the products in its sub-categories only while propagation is on
for this attribute. 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.

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 of the catalog node/category where the attribute value will be updated.

Example: 634c26e14cedfd0001775e9f

string
required

The ID of the attribute definition whose value will be updated.

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
attributeValue
object | null
boolean | null

Propagation: when true, this attribute and its value are inherited by the subcategories of this category and
by their products. Only the category that switched propagation on can change it.

boolean | null

Lock attribute value: when true, the attribute on products in the category must keep the CLA value for those
products to be valid for synchronization. Not supported for column, matrix and compound definitions, which
reject this field.

boolean | null

Make attribute value mandatory: when true, the attribute on products in the category must have a value for
those products to be valid for synchronization.

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

Indicates that the update request was accepted and the propagation task has been scheduled.

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