Update Product Promotion

post

https://api.sitevibes.com/v1/loyalty/product-promotions/{promotionId}

Update loyalty product promotion

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

promotionId

string

required

ID of promotion to update

Body Params

app_id

string

required

Identifier used to differentiate different applications api is used in

enabled

boolean

Should promotion be enabled

title

string

Promotion title

description

string | null

Promotion description

start_date

date

Promotion start date

end_date

date

Promotion end date

earn_types

array of strings

Enable promotion for specified Earn types (store_order, store_review, product_question_answer).

earn_types

channels

array of strings | null

Replace the channel restriction for this promotion. A non-empty array restricts the promotion to those channels; an empty array clears the restriction. Omit the field to leave the existing configuration unchanged.

channels

custom_points

boolean

Defaults to false

Use custom product points instead of multiplier (can be enabled only for "products" Promotion type)

multiplier

number

Promotion multiplier. From 0x to 50x.

points

number

Product custom points (used instead of multiplier when custom_points is enabled)

override_eligibility

boolean

Defaults to false

Ignore the earn rule's category/brand restrictions so the promotion's products earn points even when they fall outside the allowed categories or brands (can be enabled only for "products" Promotion type)

products

array

Products IDs that promotion will be applied to (only if type is products)

products

200Success

401Access token is missing or invalid

422Some required fields are missing or invalid