Update Product Attribute

POST

admin

product-attributes

{id}

curl -X POST 'http://localhost:9000/admin/product-attributes/pattr_01HXYZABCDEF' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Fabric", "is_filterable": true}'

const { product_attribute } = await client.admin.productAttributes.$id.mutate({
  $id: "pattr_01HXYZABCDEF",
  name: "Fabric",
  is_filterable: true,
})

{
  "product_attribute": {
    "id": "pattr_01HXYZABCDEF",
    "name": "Fabric",
    "handle": "material",
    "type": "single_select",
    "is_filterable": true,
    "updated_at": "2026-06-02T09:00:00.000Z"
  }
}

Updates the attribute’s details; only the provided fields are changed.

type is immutable. Sending a type different from the attribute’s current type returns an error.

Path parameters

string

required

The attribute’s ID.

Body parameters

string

Attribute name.

string

Unique URL-safe handle.

string

Attribute description.

string

Must match the current type: single_select, multi_select, unit, toggle, or text.

boolean

Whether a value is required on products.

boolean

Whether the attribute can be used as a storefront filter.

boolean

Whether the attribute drives variant generation; only valid for multi_select.

number

Sort rank of the attribute; must be non-negative.

boolean

Whether the attribute is active.

string[]

IDs of categories to link the attribute to; replaces the existing links.

object

Custom key-value data.

object

Custom data passed to workflow hooks.

Response

object

Show properties

string

The attribute’s ID.

string

Attribute name.

string

Unique URL-safe handle.

string

The attribute’s type.

object[]

The attribute’s values.

object[]

Linked categories with id, name, and handle.

string

Last update timestamp.

curl -X POST 'http://localhost:9000/admin/product-attributes/pattr_01HXYZABCDEF' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Fabric", "is_filterable": true}'

const { product_attribute } = await client.admin.productAttributes.$id.mutate({
  $id: "pattr_01HXYZABCDEF",
  name: "Fabric",
  is_filterable: true,
})

{
  "product_attribute": {
    "id": "pattr_01HXYZABCDEF",
    "name": "Fabric",
    "handle": "material",
    "type": "single_select",
    "is_filterable": true,
    "updated_at": "2026-06-02T09:00:00.000Z"
  }
}

curl -X POST 'http://localhost:9000/admin/product-attributes/pattr_01HXYZABCDEF' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Fabric", "is_filterable": true}'

const { product_attribute } = await client.admin.productAttributes.$id.mutate({
  $id: "pattr_01HXYZABCDEF",
  name: "Fabric",
  is_filterable: true,
})

{
  "product_attribute": {
    "id": "pattr_01HXYZABCDEF",
    "name": "Fabric",
    "handle": "material",
    "type": "single_select",
    "is_filterable": true,
    "updated_at": "2026-06-02T09:00:00.000Z"
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Path parameters

Body parameters

Response

​Path parameters

​Body parameters

​Response

Path parameters

Body parameters

Response