Skip to main content

Update Promo Window

PUT 

/api/inventory-forecasting/promo-windows/:id

Update a promo window. A full representation is expected, mirroring create.

Authentication: Requires Bearer token.

Editing the date range, order_tag, or scope changes what a future Measure Promo Lift call will consider; re-measure afterwards so any promo_lift demand modifier that references this window applies the refreshed lift. Because the lift is applied multiplicatively to the current baseline, the same window keeps re-scaling as demand grows.

Path parameter: id - the promo window to update.

Body fields:

  • name (required): label for the window, up to 255 characters.
  • start_date (required, YYYY-MM-DD): must be on or before end_date.
  • end_date (required, YYYY-MM-DD): must be on or after start_date.
  • order_tag (optional): the order tag that marks orders belonging to this promotion.
  • recurrence (optional): one_off or annual (default one_off).
  • product_scope (optional): array of product IDs the window applies to.
  • channel_scope (optional): array of sales channels the window applies to.

Returns 404 if the promo window does not exist.

Request

Responses

OK

Response Headers
    Content-Type