Update an existing category item.

put

https://example.com/authoring/v1/categories/{id}

Update the category with ID {id}.
User roles: admin, manager

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID of the category to update.

Body Params

name

string

required

The name of the category. It can contain any character except for a forward slash (/).

parent

string

The ID of the parent category. A taxonomy will be created if this is omitted.

description

string

The description of the category.

permanent

boolean

Used to identify system categories, if true the category can not be deleted.

hidden

boolean

If true the category is hidden in the Shell, value is not returned if false. Default is false.

firstClassFor

string

Array of item classifications to which this taxonomy is enabled. Acceptable values "" and "imagesAndVideos", default "". By default the taxonomy is only shown where generic selection of any category in any taxonomy is allowed.

200The category was successfully updated.

400Missing or invalid fields in the JSON body or an invalid revision was supplied.

404The category with ID {id} or the parent ID in the JSON body was not found.

409A category with the same path exists.

429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.