Update a promotion

put

https://{domain_prefix}.retail.lightspeed.app/api/2026-04/promotions/{promotion_id}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

promotion_id

string

required

The promotion id

Body Params

action

object

required

Action triggered by a promotion.

add_promo_code

array of objects

A list of promo codes to associate with this promotion.

add_promo_code

channels

array of strings

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

channels

condition

object

required

A condition to determine whether a promotion should apply to a sale.

customer_group_ids

array of strings

A list of customer group IDs for the promotion.

customer_group_ids

description

string

A short description for the promotion.

end_time

string

The time the promotion ends, in UTC, e.g. 2006-01-02T15:04:05.

string

Auto-generated object ID.

loyalty_multiplier

double

The loyalty multiplier for the promotion.

name

string

required

The name of the promotion.

outlet_ids

array of strings

A list of outlet IDs for the promotion.

outlet_ids

promo_code_summary

object

start_time

string

required

The time the promotion begins, in UTC, e.g. 2006-01-02T15:04:05.

status

string

The status of the promotion.

use_promo_code

boolean

required

Whether or not this promotion uses promo codes.

Response

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json