Skip to main content
PATCH
/
api
/
v1
/
:team_slug
/
:app_slug
/
tags
/
:tag_key
Error
A valid request URL is required to generate request examples
{
  "data": {
    "attributes": [
      {
        "created_at": "<string>",
        "description": "<string>",
        "filterable": true,
        "id": "<string>",
        "key": "<string>",
        "name": "<string>",
        "template_key": "<string>",
        "template_name": "<string>",
        "translatable": true,
        "translations": {
          "description": [
            {
              "id": "<string>",
              "locale": "<string>",
              "omni_channel_translations": [
                {
                  "id": "<string>",
                  "market_id": "<string>",
                  "store_group_id": "<string>",
                  "value": "<string>"
                }
              ],
              "value": "<string>"
            }
          ],
          "name": [
            {
              "id": "<string>",
              "locale": "<string>",
              "omni_channel_translations": [
                {
                  "id": "<string>",
                  "market_id": "<string>",
                  "store_group_id": "<string>",
                  "value": "<string>"
                }
              ],
              "value": "<string>"
            }
          ]
        },
        "updated_at": "<string>",
        "values": {}
      }
    ],
    "created_at": "<string>",
    "filterable": true,
    "id": "<string>",
    "key": "<string>",
    "markets": [
      {
        "active": true,
        "country_codes": [
          "<string>"
        ],
        "created_at": "<string>",
        "currency_code": "<string>",
        "id": "<string>",
        "locale": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "updated_at": "<string>"
      }
    ],
    "name": "<string>",
    "schedules": [
      {
        "add_category_names": [
          "<string>"
        ],
        "add_collection_names": [
          "<string>"
        ],
        "add_tag_names": [
          "<string>"
        ],
        "execute_at": "<string>",
        "finished_at": "<string>",
        "id": "<string>",
        "item_id": "<string>",
        "item_name": "<string>",
        "item_type": "<string>",
        "remove_category_names": [
          "<string>"
        ],
        "remove_collection_names": [
          "<string>"
        ],
        "remove_tag_names": [
          "<string>"
        ],
        "to_amount_cents_with_tax": 123,
        "to_market_id": "<string>",
        "to_market_status": "<string>",
        "to_on_sale": true,
        "to_sale_amount_cents_with_tax": 123,
        "to_status": "<string>",
        "to_store_group_id": "<string>"
      }
    ],
    "status": "<string>",
    "translations": {
      "name": [
        {
          "id": "<string>",
          "locale": "<string>",
          "omni_channel_translations": [
            {
              "id": "<string>",
              "market_id": "<string>",
              "store_group_id": "<string>",
              "value": "<string>"
            }
          ],
          "value": "<string>"
        }
      ]
    },
    "updated_at": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

​
tag_key
string
required

Tag key

Body

application/json

Tag update data

​
attributes_keys
string[]
​
filterable
boolean
​
name
string
​
new_key
string
​
status
enum<string>
Available options:
active,
inactive,
archived,
draft

Response

Tag updated successfully

​
data
object
​
details
string[]

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