Create or update a category.

PUT

/catalogs/{catalogID}/categories/{categoryID}

200

Description

If an object with the same ID already exists, it will be overwritten.

Setting adjustListOrders to true will increase ListOrder for all categories with the same or higher ListOrder.

Roles

At least one of the roles below is required to access this endpoint.

FullAccessCategoryAdmin

Parameters

Name		Type	Description	Possible Values
catalogID	Required	`string`	ID of the catalog.	---
categoryID	Required	`string`	ID of the category.	---
adjustListOrders		`boolean`	Adjust list orders of the category.	---

Request Body

Property		Type	Format	Max Length	Possible Values
ID		`string`	---	100 characters	---
Name	Required	`string`	---	100 characters	---
Description		`string`	---	2000 characters	---
ListOrder		`integer`	int32	---	---
Active		`boolean`	---	---	---
ParentID		`string`	---	---	---
xp		`object`	---	---	---

Response Body

Property		Type	Format	Max Length	Possible Values
ID		`string`	---	100 characters	---
Name		`string`	---	100 characters	---
Description		`string`	---	2000 characters	---
ListOrder		`integer`	int32	---	---
Active		`boolean`	---	---	---
ParentID		`string`	---	---	---
ChildCount	Read Only	`integer`	int32	---	---
xp		`object`	---	---	---