DocsDocsReference

Update attribute template

Updates an existing attribute template including its name, key, type, fields, and resource associations. If a field with the same key already exists, it will be updated rather than duplicated.

PATCH/api/v1/{team_slug}/{app_slug}/attributes/{attribute_template_key}
API
Management
Updated
Apr 26, 2026

management-api:PATCH:/api/v1/{team_slug}/{app_slug}/attributes/{attribute_template_key}

Updates an existing attribute template including its name, key, type, fields, and resource associations. If a field with the same key already exists, it will be updated rather than duplicated.

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\}
  • Summary: Update attribute template
  • Description: Updates an existing attribute template including its name, key, type, fields, and resource associations. If a field with the same key already exists, it will be updated rather than duplicated.
  • 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.

Parameters3 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
attribute_template_keypathYesstringKey of the attribute template
Request bodyDocumented body
  • Required: Yes
  • Description: Attribute data
  • Content: application/json (object)

Update Attribute Template Payload

PropertyTypeRequiredDetails
fieldsobject[]No-
filterablebooleanNo-
keystringNoKey of the attribute
namestringNoName of the attribute
resourcesstring[]No-
translatablebooleanNo-
typestringNoName of the attribute

Input Attribute Field

PropertyTypeRequiredDetails
keystringYesKey of the attribute template field
namestringYesName for the attribute template field
typeenum("boolean", "text", "number", "image", "color", "image_object")YesThe type of the attribute template field. This field defines how we should treat the field when you create, update or list attributes

Generated example (synthetic):

{
  "fields": [
    {
      "key": "string",
      "name": "string",
      "type": "boolean"
    }
  ],
  "filterable": false,
  "key": "string",
  "name": "string",
  "resources": [
    "string"
  ],
  "translatable": false,
  "type": "string"
}
Responses4 statuses
StatusDescriptionContent
200Attribute templateapplication/json (object)
400Invalid request (e.g. bad UUID, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Attribute Template Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Attribute Template
PropertyTypeRequiredDetails
attributesobject[]No-
created_atstringNo-
fieldsobject[]No-
filterablebooleanNo-
idstringNo-
keystringNo-
namestringNo-
resourcesstring[]No-
source_app_idstringNo-
source_idstringNo-
translatablebooleanNo-
typestringNo-
updated_atstringNo-
Attribute
PropertyTypeRequiredDetails
created_atstringNo-
descriptionstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
namestringNo-
template_keystringNo-
template_namestringNo-
translatablebooleanNo-
translationsobjectNo-
updated_atstringNo-
valuesobjectNo-
Attribute Template Field
PropertyTypeRequiredDetails
created_atstringNo-
idstringNo-
keystringNo-
namestringNo-
typestringNo-
updated_atstringNo-
{
  "data": {
    "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": {}
      }
    ],
    "created_at": "string",
    "fields": [
      {
        "created_at": "string",
        "id": "string",
        "key": "string",
        "name": "string",
        "type": "string",
        "updated_at": "string"
      }
    ],
    "filterable": false,
    "id": "string",
    "key": "string",
    "name": "string",
    "resources": [
      "string"
    ],
    "source_app_id": "string",
    "source_id": "string",
    "translatable": false,
    "type": "string",
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "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\}
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Attribute Templates
  • OpenAPI summary: Update attribute template

Update attribute template

# Update attribute template Updates an existing attribute template including its name, key, type, fields, and resource associations. If a field with the same key already exists, it will be updated rather than duplicated.
PATCH /api/v1/{team_slug}/{app_slug}/attributes/{attribute_template_key}
Purpose

Updates an existing attribute template including its name, key, type, fields, and resource associations.

Required inputs

app_slug path team_slug path attribute_template_key path

Primary response

200 ยท Attribute template

Operation key

management-api:PATCH:/api/v1/{team_slug}/{app_slug}/attributes/{attribute_template_key}

## 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](/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}` - Summary: Update attribute template - Description: Updates an existing attribute template including its name, key, type, fields, and resource associations. If a field with the same key already exists, it will be updated rather than duplicated. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PATCH:/api/v1/{team_slug}/{app_slug}/attributes/{attribute_template_key}` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | attribute_template_key | path | Yes | string | Key of the attribute template | ## Request body - Required: Yes - Description: Attribute data - Content: application/json (object) ### Update Attribute Template Payload | Property | Type | Required | Details | | --- | --- | --- | --- | | `fields` | object[] | No | - | | `filterable` | boolean | No | - | | `key` | string | No | Key of the attribute | | `name` | string | No | Name of the attribute | | `resources` | string[] | No | - | | `translatable` | boolean | No | - | | `type` | string | No | Name of the attribute | #### Input Attribute Field | Property | Type | Required | Details | | --- | --- | --- | --- | | `key` | string | Yes | Key of the attribute template field | | `name` | string | Yes | Name for the attribute template field | | `type` | enum("boolean", "text", "number", "image", "color", "image_object") | Yes | The type of the attribute template field. This field defines how we should treat the field when you create, update or list attributes | **Generated example (synthetic):** ```json { "fields": [ { "key": "string", "name": "string", "type": "boolean" } ], "filterable": false, "key": "string", "name": "string", "resources": [ "string" ], "translatable": false, "type": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Attribute template | application/json (object) | | 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Attribute Template Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Attribute Template | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `created_at` | string | No | - | | `fields` | object[] | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `name` | string | No | - | | `resources` | string[] | No | - | | `source_app_id` | string | No | - | | `source_id` | string | No | - | | `translatable` | boolean | No | - | | `type` | string | No | - | | `updated_at` | string | No | - | ##### Attribute | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `description` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `name` | string | No | - | | `template_key` | string | No | - | | `template_name` | string | No | - | | `translatable` | boolean | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `values` | object | No | - | ##### Attribute Template Field | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `id` | string | No | - | | `key` | string | No | - | | `name` | string | No | - | | `type` | string | No | - | | `updated_at` | string | No | - |
Generated example (synthetic) ```json { "data": { "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": {} } ], "created_at": "string", "fields": [ { "created_at": "string", "id": "string", "key": "string", "name": "string", "type": "string", "updated_at": "string" } ], "filterable": false, "id": "string", "key": "string", "name": "string", "resources": [ "string" ], "source_app_id": "string", "source_id": "string", "translatable": false, "type": "string", "updated_at": "string" }, "details": [ "string" ], "success": false } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "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}` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PATCH:/api/v1/{team_slug}/{app_slug}/attributes/{attribute_template_key}` - OpenAPI tag: Attribute Templates - OpenAPI summary: Update attribute template