Update Stream

put

https://{yourinstance}.makaira.io/stream/{id}

Update Stream by ID.

This endpoints allows for configuring the stream and therefore restricting, what products will be included in the stream.

Since the combination "field/type/operator" (see the "query" part in the body description) is relying on logic based on the selected fields, like what operators can be applied to what field types, we recommend using the GUI to configure your stream and refer to https://www.makaira.io/docs/configuration/productStreams.html for further documentation on what operators are available for each field type.

Updates an existing stream's title or boost factor.

Requires authentication.

Request

PUT /stream/{id}

Path Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The ID of the stream to update.

Headers

Header	Value
`Authorization`	`Bearer <token>`
`Content-Type`	`application/json`

Request Body

Field	Type	Required	Description
`title`	string	No	Updated display title.
`boostFactor`	number	No	Updated boost factor. Range: `-99` to `99`.

Example Request

{
  "title": "Best Sellers",
  "boostFactor": 75
}

Response

Returns the updated stream object.

Example Response

{
  "id": 3,
  "title": "Best Sellers",
  "boostFactor": 75
}

Response

200