Skip to main content
PATCH
Update Promotion

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Path Parameters

promotionId
string
required

Query Parameters

organizationId
string

Optional organization scope for session-authenticated calls. OAuth client credentials resolve the organization from the token.

Maximum string length: 120

Body

application/json
organizationId
string
Maximum string length: 120
name
string
Maximum string length: 200
description
string | null
Maximum string length: 2000
kind
enum<string>
Available options:
product_discount,
flash_sale,
voucher,
gift_with_purchase,
buy_x_get_y,
bundle_deal,
free_shipping,
early_bird_price
discountType
enum<string>
Available options:
percentage,
fixed_amount
discountValue
number

Discount amount or percentage. Use 0 for gift/sample-only and free Buy-X-Get-Y mechanics.

Required range: x >= 0
targetStores
object[]
Required array length: 1 - 100 elements
startsAt
string<date-time> | null
endsAt
string<date-time> | null
status
enum<string>
Available options:
draft,
scheduled,
active,
paused,
ended,
archived
minSalePrice
number | null
Required range: x >= 0
maxDiscountAmount
number | null
Required range: x >= 0
minSpend
number | null
Required range: x >= 0
totalUsageLimit
integer | null
Required range: x >= 1
mechanicConfig
object
storeDiscounts
object[]

Patch discount overrides by exact target store key. Other stores retain their terms. Null discountValue restores shared terms for that store.

Maximum array length: 100

Response

Promotion updated.

promotion
object
required