Update Category

Update Category by ID

Updates the search configuration for a specific category, such as assigning a boost stream or configuring category-specific aggregations.

Requires authentication.

Request

PUT /category/{id}

Path Parameters

ParameterTypeRequiredDescription
idstringYesThe category identifier from the shop system.

Headers

HeaderValue
AuthorizationBearer <token>
Content-Typeapplication/json

Request Body

FieldTypeRequiredDescription
streamstringNoID of the boost stream to assign to this category.
aggregationsarrayNoArray of aggregation IDs to use for this category.
overrideAggregationsbooleanNoWhen true, uses the category-specific aggregations instead of global defaults.
overrideAggregationSortingbooleanNoWhen true, uses category-specific aggregation sorting.

Example Request

{
  "stream": "3",
  "aggregations": ["1", "2", "5"],
  "overrideAggregations": true
}

Response

Returns the updated category configuration.

Path Params
string
required
Body Params
string

The stream ID for the category.

aggregations
array of strings

List of aggregation IDs for the category. Contains only the IDs.

aggregations
boolean

Flag to override aggregations.

boolean

Flag to override aggregation sorting.

aggregationSorting
array of objects

Array of objects, each with dynamic keys representing aggregation identifiers and integer values indicating their sort positions.

aggregationSorting
Headers
string
required

Makaira Instance ID

Response
200

OK

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!