Skip to content

Catalog Attribute — Delete (GraphQL)

Deletes a user-defined attribute. id is the attribute IRI (/api/admin/catalog/attributes/{id}). The mutation returns a snapshot of the deleted attribute.

A system attribute (isUserDefined = 0) cannot be deleted (403), and an attribute still attached to one or more attribute families is refused until it is removed from those families (409).

TIP

See the Attributes overview for how attributes, options, and families fit together.

Each failure returns an errors[] entry:

ConditionMessage
System attribute (isUserDefined = 0)System attributes cannot be deleted.
Attribute is referenced by one or more attribute familiesAttribute is part of one or more attribute families. Remove it from those families first.
Unknown idAttribute not found.

For bulk deletion, use createAdminAttributeMassDelete.

All admin operations require an admin Bearer token — see Authentication.

Released under the MIT License.