Update a promotion

This endpoint updates an existing promotion by ID.

All of a promotion's fields except its id may be updated.
There are no partial updates.
All fields must be specified in the update.
The response contains the updated promotion object.

🔒 Requires: promotions:write scope

promotion_idstring required

The promotion id

Request body

channelsstring[]

A list of channels for the promotion. Can be Register, Ecommerce.

customer_group_idsstring[]

A list of customer group IDs for the promotion.

descriptionstring

A short description for the promotion.

end_timestring nullable

The time the promotion ends, in UTC, e.g. 2006-01-02T15:04:05 (no timezone suffix).

idstring

Auto-generated object ID.

loyalty_multipliernumber double

The loyalty multiplier for the promotion.

namestring required

The name of the promotion.

outlet_idsstring[]

A list of outlet IDs for the promotion.

start_timestring required

The time the promotion begins, in UTC, e.g. 2006-01-02T15:04:05 (no timezone suffix).

statusstring

The status of the promotion.

use_promo_codeboolean required

Whether or not this promotion uses promo codes.

Response

channelsstring[]

A list of channels for the promotion. Can be Register, Ecommerce.

combinable_with_couponboolean nullable

Whether this promotion can be combined with an online coupon.

customer_group_idsstring[]

A list of customer group IDs for the promotion.

descriptionstring

A short description for the promotion.

end_timestring nullable

The time the promotion ends, in UTC, e.g. 2006-01-02T15:04:05 (no timezone suffix).

idstring

Auto-generated object ID.

loyalty_multipliernumber double nullable

The loyalty multiplier for the promotion.

namestring

The name of the promotion.

online_channel_idsinteger[]

A list of online channel IDs for the promotion.

outlet_idsstring[] nullable

A list of outlet IDs for the promotion.

show_potentialboolean

Whether this promotion is shown as part of potential promotions.

start_timestring