Znode

Build Version:

PUT categories/{categoryId}

Updates an existing category.

Request Information

» Parameters

Name Description Additional information
categoryId The ID of the category.

Define this parameter in the request URI.

model The model of the category.

Define this parameter in the request body.

Request Body Formats

Sample:
	{
  "AlternateDescription": "sample string 1",
  "CategoryId": 2,
  "CategoryNodes": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "Catalog": {
          "$id": "4",
          "CatalogId": 1,
          "ExternalId": "sample string 2",
          "IsActive": true,
          "Name": "sample string 4",
          "PortalId": 1,
          "PreserveCategories": true,
          "IsDefault": true,
          "IsFromSitecore": true,
          "ProductIds": "sample string 8",
          "ProductCount": 9,
          "CategoryCount": 10
        },
        "CatalogId": 1,
        "Category": {
          "$ref": "1"
        },
        "CategoryId": 1,
        "CategoryNodeId": 2,
        "BeginDate": "2025-04-28T02:28:19.915532+00:00",
        "CssId": 1,
        "DisplayOrder": 1,
        "EndDate": "2025-04-28T02:28:19.915532+00:00",
        "IsActive": true,
        "MasterPageId": 1,
        "ParentCategoryNodeId": 1,
        "ThemeId": 1,
        "ErrorMessage": "sample string 4",
        "Name": "sample string 5",
        "Title": "sample string 6",
        "VisibleInd": true,
        "IsCategoryAssociated": true
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "CategoryProfiles": {
    "$id": "5",
    "$values": [
      {
        "$id": "6",
        "CategoryProfileID": 1,
        "CategoryID": 2,
        "ProfileID": 3,
        "EffectiveDate": "2025-04-28T02:28:19.915532+00:00",
        "ProfileName": "sample string 5"
      },
      {
        "$ref": "6"
      },
      {
        "$ref": "6"
      }
    ]
  },
  "CategoryUrl": "sample string 3",
  "CreateDate": "2025-04-28T02:28:19.915532+00:00",
  "Custom1": "sample string 4",
  "Custom2": "sample string 5",
  "Custom3": "sample string 6",
  "Description": "sample string 7",
  "DisplayOrder": 1,
  "ExternalId": "sample string 8",
  "ImageAltTag": "sample string 9",
  "ImageFile": "sample string 10",
  "ImageLargePath": "sample string 11",
  "ImageMediumPath": "sample string 12",
  "ImageSmallPath": "sample string 13",
  "ImageSmallThumbnailPath": "sample string 14",
  "ImageThumbnailPath": "sample string 15",
  "IsVisible": true,
  "Name": "sample string 17",
  "ProductIds": "sample string 18",
  "SeoDescription": "sample string 19",
  "SeoKeywords": "sample string 20",
  "SeoTitle": "sample string 21",
  "SeoUrl": "sample string 22",
  "ShortDescription": "sample string 23",
  "RedirectUrlInd": true,
  "Subcategories": {
    "$id": "7",
    "$values": [
      {
        "$ref": "1"
      },
      {
        "$ref": "1"
      },
      {
        "$ref": "1"
      }
    ]
  },
  "SubcategoryGridIsVisible": true,
  "IsAssociate": true,
  "Title": "sample string 27",
  "UpdateDate": "2025-04-28T02:28:19.915532+00:00",
  "CategoryBanner": "sample string 28",
  "PortalID": 1,
  "ProductId": 29,
  "CategoryIds": "sample string 30",
  "UserName": "sample string 31",
  "IsFromSitecore": true,
  "ProductCount": 33,
  "ParentCategoryNodeId": 34,
  "IsActive": true,
  "ActiveProductCount": 36,
  "FacetsGroups": {
    "$id": "8",
    "$values": [
      {
        "$id": "9",
        "FacetGroupID": 1,
        "FacetGroupLabel": "sample string 2",
        "ControlTypeID": 1,
        "CatalogID": 1,
        "DisplayOrder": 1,
        "FacetGroupCategories": {
          "$id": "10",
          "$values": [
            {
              "$id": "11",
              "FacetGroupID": 1,
              "CategoryID": 2,
              "CategoryDisplayOrder": 1
            },
            {
              "$ref": "11"
            },
            {
              "$ref": "11"
            }
          ]
        },
        "FacetGroupFacets": {
          "$id": "12",
          "$values": [
            {
              "$id": "13",
              "FacetID": 1,
              "FacetGroupID": 1,
              "FacetName": "sample string 2",
              "FacetDisplayOrder": 1,
              "IconPath": "sample string 3"
            },
            {
              "$ref": "13"
            },
            {
              "$ref": "13"
            }
          ]
        },
        "FacetName": "sample string 3"
      },
      {
        "$ref": "9"
      },
      {
        "$ref": "9"
      }
    ]
  },
  "Properties": {
    "$id": "14",
    "IsFeatured": true
  },
  "CatalogCount": 37
}