Skip to main content

attributeDescriptionUpdate

Update an existing attribute description's configuration.

Modifies attribute description details including metadata, display settings, and localization options. Only provided fields will be updated, others remain unchanged.

Possible errors:

  • ATTRIBUTE_DESCRIPTION_NOT_FOUND: Attribute description with the specified ID does not exist
  • ATTRIBUTE_DESCRIPTION_UPDATE: Failed to update the attribute description
  • FORBIDDEN: Insufficient permissions

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

attributeDescriptionUpdate(
  id: String!
  input: AttributeDescriptionUpdateInput!
): AttributeDescription!

Arguments​

attributeDescriptionUpdate.id ● String! non-null scalar​

Unique identifier of the attribute description to update.

Must be a valid UUID format representing an existing attribute description in the system.

attributeDescriptionUpdate.input ● AttributeDescriptionUpdateInput! non-null input​

Updated attribute description information.

Contains the attribute description properties to update. Only provided fields will be changed, others remain unchanged.

Type​

AttributeDescription object​

Attribute description schema defining the structure and metadata for attributes.

Serves as a template that defines how attributes should be structured and displayed. Contains type information, the entity type, localization settings, and default values that govern attribute behavior across the system.

An attribute description is the definition/blueprint of an attribute, specifying what entity it applies to (product, company, etc.), what data type it is (text, int, etc.), localized descriptions, and default values. The actual attributes are just the specific values assigned to objects using this description as their template. You must first define the attribute description, then use it to assign values to specific objects.