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.
Log in to see full request history
Path Params
string
required

The promotion id

Body Params
string

Auto-generated object ID.

string
required

The name of the promotion.

string

A short description for the promotion.

string
required

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

string

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

object
required

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

object
required

Action triggered by a promotion.

double

The loyalty multiplier for the promotion.

array of strings

A list of outlet IDs for the promotion.

outlet_ids
array of strings

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

channels
array of strings

A list of customer group IDs for the promotion.

customer_group_ids
string

The status of the promotion.

boolean
required

Whether or not this promotion uses promo codes.

array of objects

A list of promo codes to associate with this promotion.

add_promo_code
array of objects

A summary of the added promo codes added.

promo_code_summary
Response

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json