Update Category

Updates a category with partial data. Only provided fields are updated. If parent_id is omitted or null, the category becomes a root category

PATCH/api/v1/{team_slug}/{app_slug}/categories/{category_id}

Authorization

AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters

app_slugstringrequired

App slug

team_slugstringrequired

Team slug

category_idstringrequired

Category ID

Request body

requiredapplication/json

Category data

childlessboolean

cover_idstring

CoverID controls the category's cover image. When omitted, the cover is not changed. When set to a UUID, the image is validated and assigned. When set to null, the cover is removed.

descriptionstring

google_product_category_idstring

related google product category in https://www.google.com/basepages/producttype/taxonomy-with-ids.en-US.txt

namestring

parent_idstring

seointernal_pkg_webserver_v1.InputUpdateCategorySEO

Show properties

meta_descriptionstring

meta_titlestring

slugstring

sort_orderinteger

min 0

statusstring

Allowed:activedraftinactive

translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.CategoryTranslations

Show properties

descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Translation

idstring

localestring

valuestring

meta_descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Translation

idstring

localestring

valuestring

meta_titlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Translation

idstring

localestring

valuestring

namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Translation

idstring

localestring

valuestring

sluggithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Translation

idstring

localestring

valuestring

Responses

200

The category

datagithub_com_enadhq_nabbit_internal_pkg_webserver_models.Categoryrequired

Show properties

attributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute

created_atstring

descriptionstring | null

filterableboolean | null

idstring

keystring

namestring | null

template_keystring

template_namestring

translatableboolean | null

translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.AttributeTranslations

Show properties

descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

updated_atstring | null

valuesobject | null

childrengithub_com_enadhq_nabbit_internal_pkg_webserver_models.Category[]

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Category

Circular reference to github_com_enadhq_nabbit_internal_pkg_webserver_models.Category.

cover_urlstring

created_atstring

descriptionstring

google_product_category_idstring | null

idstring

namestring

parent_idstring

redirectsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Redirects[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Redirects

idstring

item_idstring | null

localestring

new_slugstring

old_slugstring

typegithub_com_enadhq_nabbit_internal_pkg_webserver_models.RedirectType

Allowed:productpagecollectioncategoryproduct_bundle

seogithub_com_enadhq_nabbit_internal_pkg_webserver_models.CategorySEO | null

Show properties

Any of:

github_com_enadhq_nabbit_internal_pkg_webserver_models.CategorySEO

meta_descriptionstring

meta_titlestring

null

null

slugstring

sort_orderinteger

statusstring

translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.CategoryTranslations

Show properties

descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Translation

idstring

localestring

valuestring

meta_descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

meta_titlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null

sluggithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null

updated_atstring | null

uristring | null

detailsstring[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

successbooleanrequired

400

Invalid request (e.g. bad UUID, validation error)

detailsstring[]

messagestring

successbooleanrequired

401

Unauthorized access

detailsstring[]

messagestring

successbooleanrequired

500

Internal server error

detailsstring[]

messagestring

successbooleanrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

app_slugpath*App slugteam_slugpath*Team slugcategory_idpath*Category ID

Bodyapplication/json

Request body

Request

curl -X PATCH 'https://api.enad.io/api/v1/string/string/categories/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "childless": true,
  "cover_id": "string",
  "description": "string",
  "google_product_category_id": "string",
  "name": "string",
  "parent_id": "string",
  "seo": {
    "meta_description": "string",
    "meta_title": "string"
  },
  "slug": "string",
  "sort_order": 0,
  "status": "active",
  "translations": {
    "description": [
      {
        "id": "string",
        "locale": "string",
        "value": "string"
      }
    ],
    "meta_description": [
      {
        "id": "string",
        "locale": "string",
        "value": "string"
      }
    ],
    "meta_title": [
      {
        "id": "string",
        "locale": "string",
        "value": "string"
      }
    ],
    "name": [
      {
        "id": "string",
        "locale": "string",
        "value": "string"
      }
    ],
    "slug": [
      {
        "id": "string",
        "locale": "string",
        "value": "string"
      }
    ]
  }
}'

const response = await fetch("https://api.enad.io/api/v1/string/string/categories/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"childless\": true,\n  \"cover_id\": \"string\",\n  \"description\": \"string\",\n  \"google_product_category_id\": \"string\",\n  \"name\": \"string\",\n  \"parent_id\": \"string\",\n  \"seo\": {\n    \"meta_description\": \"string\",\n    \"meta_title\": \"string\"\n  },\n  \"slug\": \"string\",\n  \"sort_order\": 0,\n  \"status\": \"active\",\n  \"translations\": {\n    \"description\": [\n      {\n        \"id\": \"string\",\n        \"locale\": \"string\",\n        \"value\": \"string\"\n      }\n    ],\n    \"meta_description\": [\n      {\n        \"id\": \"string\",\n        \"locale\": \"string\",\n        \"value\": \"string\"\n      }\n    ],\n    \"meta_title\": [\n      {\n        \"id\": \"string\",\n        \"locale\": \"string\",\n        \"value\": \"string\"\n      }\n    ],\n    \"name\": [\n      {\n        \"id\": \"string\",\n        \"locale\": \"string\",\n        \"value\": \"string\"\n      }\n    ],\n    \"slug\": [\n      {\n        \"id\": \"string\",\n        \"locale\": \"string\",\n        \"value\": \"string\"\n      }\n    ]\n  }\n}"
});

import requests

response = requests.patch(
    "https://api.enad.io/api/v1/string/string/categories/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"childless\": true,\n  \"cover_id\": \"string\",\n  \"description\": \"string\",\n  \"google_product_category_id\": \"string\",\n  \"name\": \"string\",\n  \"parent_id\": \"string\",\n  \"seo\": {\n    \"meta_description\": \"string\",\n    \"meta_title\": \"string\"\n  },\n  \"slug\": \"string\",\n  \"sort_order\": 0,\n  \"status\": \"active\",\n  \"translations\": {\n    \"description\": [\n      {\n        \"id\": \"string\",\n        \"locale\": \"string\",\n        \"value\": \"string\"\n      }\n    ],\n    \"meta_description\": [\n      {\n        \"id\": \"string\",\n        \"locale\": \"string\",\n        \"value\": \"string\"\n      }\n    ],\n    \"meta_title\": [\n      {\n        \"id\": \"string\",\n        \"locale\": \"string\",\n        \"value\": \"string\"\n      }\n    ],\n    \"name\": [\n      {\n        \"id\": \"string\",\n        \"locale\": \"string\",\n        \"value\": \"string\"\n      }\n    ],\n    \"slug\": [\n      {\n        \"id\": \"string\",\n        \"locale\": \"string\",\n        \"value\": \"string\"\n      }\n    ]\n  }\n}",
)

Response

{
  "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",
              "value": "string"
            }
          ],
          "name": [
            {
              "id": "string",
              "locale": "string",
              "value": "string"
            }
          ]
        },
        "updated_at": "string",
        "values": {
          "property1": {
            "field_id": "string",
            "id": "string",
            "image_id": "string",
            "image_object": {
              "alt": "string",
              "app_id": "string",
              "blurhash": "string",
              "copyright": "string",
              "custom": {
                "property1": "string",
                "property2": "string"
              },
              "folder_id": "string",
              "id": "string",
              "parent_id": "string",
              "public": true,
              "status": "string",
              "title": "string",
              "url": "string"
            },
            "translations": {
              "value": [
                {
                  "id": "string",
                  "locale": "string",
                  "value": "string"
                }
              ]
            },
            "type": "string",
            "value": "string"
          },
          "property2": {
            "field_id": "string",
            "id": "string",
            "image_id": "string",
            "image_object": {
              "alt": "string",
              "app_id": "string",
              "blurhash": "string",
              "copyright": "string",
              "custom": {
                "property1": "string",
                "property2": "string"
              },
              "folder_id": "string",
              "id": "string",
              "parent_id": "string",
              "public": true,
              "status": "string",
              "title": "string",
              "url": "string"
            },
            "translations": {
              "value": [
                {
                  "id": "string",
                  "locale": "string",
                  "value": "string"
                }
              ]
            },
            "type": "string",
            "value": "string"
          }
        }
      }
    ],
    "children": [
      {}
    ],
    "cover_url": "string",
    "created_at": "string",
    "description": "string",
    "google_product_category_id": "string",
    "id": "string",
    "name": "string",
    "parent_id": "string",
    "redirects": [
      {
        "id": "string",
        "item_id": "string",
        "locale": "string",
        "new_slug": "string",
        "old_slug": "string",
        "type": "product"
      }
    ],
    "seo": {
      "meta_description": "string",
      "meta_title": "string"
    },
    "slug": "string",
    "sort_order": 0,
    "status": "string",
    "translations": {
      "description": [
        {
          "id": "string",
          "locale": "string",
          "value": "string"
        }
      ],
      "meta_description": [
        {
          "id": "string",
          "locale": "string",
          "value": "string"
        }
      ],
      "meta_title": [
        {
          "id": "string",
          "locale": "string",
          "value": "string"
        }
      ],
      "name": [
        {
          "id": "string",
          "locale": "string",
          "value": "string"
        }
      ],
      "slug": [
        {
          "id": "string",
          "locale": "string",
          "value": "string"
        }
      ]
    },
    "updated_at": "string",
    "uri": "string"
  },
  "details": [
    "string"
  ],
  "success": true
}

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

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

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