LIlivelike

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.

patch/{client_id}/categories/{id}/

Request

  • Base URL
    https://cf-blast.livelikecdn.com/api/v1/applications
  • URL
    https://cf-blast.livelikecdn.com/api/v1/applications/{client_id}/categories/{id}/
  • Auth
    API key in header Authorization

Path parameters

client_idstring required

The client ID of the application.

idstring uuid required

The ID of the category.

Request body

namestring

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

descriptionstring

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

sequenceinteger nullable

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

custom_datastring

Free text, for example serialized JSON.

Response

OK. The updated category.

idstring uuid
namestring
sequenceinteger nullable
statestring

Changes

No recorded changes to this operation across all 1 revision of this API.