Update Category

Updates a category. Send only the fields you want to change. Requires a producer access token for the application.

The store of a category can't be changed. The name must stay unique among the store's active categories, and sequence must stay unique too. attributes is a full replacement: send the complete list, and send an empty list to clear it. Omitting a field leaves it unchanged. The response is the updated category, in the same shape as Retrieve Category.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The client ID of the application.

uuid
required

The ID of the category.

Body Params
string
length ≤ 255

Name of the category. Max 255 characters, and unique among the store's active categories.

string

Description of the category. Required before the category can be published.

integer | null
≥ 0

Position of the category in the store, zero or higher. Must be unique among the store's active categories.

string

Free text, for example serialized JSON.

attributes
array of objects

Full replace. Both key and value are required on every item. An identical pair twice is rejected.

attributes
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json