Updates an existing attribute including its key, name, description, and field values. Field values are validated against the template's field types (e.g., image fields must be valid images, number fields must be numeric). For image fields, you may upload a file, pass a public image URL in the field key, or reference an existing app image by UUID via form field image_id when the field key is image, otherwise _image_id.

API ownership

• API family: Management API
• Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
• Do not use from: Browser-only storefront code or public clients.
• Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

• Method: PATCH
• Path: /api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/\{attribute_key\}
• Summary: Update attribute
• Description: Updates an existing attribute including its key, name, description, and field values. Field values are validated against the template's field types (e.g., image fields must be valid images, number fields must be numeric). For image fields, you may upload a file, pass a public image URL in the field key, or reference an existing app image by UUID via form field image_id when the field key is image, otherwise _image_id.
• OpenAPI contract: management-api
• Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

{
  "key": "string",
  "name": "string",
  "description": "string"
}

{
  "data": {
    "created_at": "string",
    "description": "string",
    "fields": [
      {
        "created_at": "string",
        "id": "string",
        "key": "string",
        "name": "string",
        "type": "string",
        "updated_at": "string"
      }
    ],
    "filterable": false,
    "id": "string",
    "key": "string",
    "linked_attributes": [
      {
        "created_at": "string",
        "description": "string",
        "filterable": false,
        "id": "string",
        "key": "string",
        "name": "string",
        "template_key": "string",
        "template_name": "string",
        "translatable": false,
        "translations": {
          "description": null,
          "name": null
        },
        "updated_at": "string",
        "values": {}
      }
    ],
    "name": "string",
    "template_key": "string",
    "template_name": "string",
    "translatable": false,
    "translations": {
      "description": [
        {
          "id": null,
          "locale": null,
          "value": null
        }
      ],
      "name": [
        {
          "id": null,
          "locale": null,
          "value": null
        }
      ]
    },
    "updated_at": "string",
    "values": {}
  },
  "details": [
    "string"
  ],
  "success": false
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

• API family: Management API
• Method: PATCH
• Path: /api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/\{attribute_key\}
• Operation ID: Not documented in the OpenAPI contract.
• OpenAPI tag: Attributes
• OpenAPI summary: Update attribute