Skip to main content

Update category

Leaving out a property will ensure no changes are made to that property.
Collection properties will delete and/or add as necessary to match the supplied data.

Path Parameters
id int32 REQUIRED

The id of the category to update.

Request Body REQUIRED

The category data to update.

ParentCategoryId int32

The ID of the parent category. Set to 0 for a root-level category.

Names object[]

The localizable names of the category. Note that other localizable content will only be used if a name in the same language is also provided.

LanguageCode string
Content string

The localized content.

Descriptions object[]

The localized descriptions of the category. Note that only descriptions with a matching name in the same language will be used.

LanguageCode string
Content string

The localized content.

SecondaryDescriptions object[]

The localized secondary descriptions of the category. Note that only secondary descriptions with a matching name in the same language will be used.

LanguageCode string
Content string

The localized content.

Meta object

Meta information for a category.

Descriptions object[]

The localized meta descriptions of the category.

LanguageCode string
Content string

The localized content.

Keywords object[]

The localized meta keywords of the category.

LanguageCode string
Content string

The localized content.

Titles object[]

The localized meta titles of the category.

LanguageCode string
Content string

The localized content.

Hidden boolean

Indicates if the category should be hidden from menus, filters etc.

Active boolean

True if the category is active for use.

Responses
200

The updated category.

Schema OPTIONAL
Resource object OPTIONAL

An existing category.

CategoryId int32 OPTIONAL

The id of the category.

ParentCategoryId int32 OPTIONAL

The id of the parent category. If the category is at the root level, this field will be 0.

Names object[] OPTIONAL

The localizable names of the category.

LanguageCode string OPTIONAL
Content string OPTIONAL

The localized content.

Descriptions object[] OPTIONAL

The localized descriptions of the category.

LanguageCode string OPTIONAL
Content string OPTIONAL

The localized content.

SecondaryDescriptions object[] OPTIONAL

The localized secondary descriptions of the category.

LanguageCode string OPTIONAL
Content string OPTIONAL

The localized content.

Meta object OPTIONAL

Meta information for a category.

Descriptions object[] OPTIONAL

The localized meta descriptions of the category.

LanguageCode string OPTIONAL
Content string OPTIONAL

The localized content.

Keywords object[] OPTIONAL

The localized meta keywords of the category.

LanguageCode string OPTIONAL
Content string OPTIONAL

The localized content.

Titles object[] OPTIONAL

The localized meta titles of the category.

LanguageCode string OPTIONAL
Content string OPTIONAL

The localized content.

GoogleCategoryPath string OPTIONAL

The Google Taxonomy category path for the category, if any.

Hidden boolean OPTIONAL

Indicates if the category should be hidden from menus, filters etc.

Active boolean OPTIONAL

True if the category is active for use.

Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.

400

Bad request.

Schema OPTIONAL
Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.