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 for the category.

Names object[]

The localizable names of the category.

LanguageCode string
Content string

The localized content.

Descriptions object[]

The localized descriptions 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 for the category.

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.

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.