PUT
/
offer
/
promotions
/
{id}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

promotion id

Body

application/json
​
customer_eligibility
enum<string>
required
Available options:
all,
customer,
segment
​
details
object
required
​
name
string
required
​
promotion_type
enum<string>
required
Available options:
discount,
free-goods,
fixed-price,
free-shipping,
buy-x-get-y,
volume-based
​
starts_at
string
required
​
status
enum<string>
required

this key is ignored in create promotion api and draft status will be added by default. required in update promotion api only.

Available options:
draft,
live,
stopped,
expired
​
applies_to_product
enum<string>
Available options:
all,
product,
category
​
can_be_used_with_promotion
boolean
default:
false
​
customer_id
string[]

required if customer_eligibility = customer

​
description
string
​
expires_at
string | null
​
for_first_time_customer_only
boolean
default:
false
​
has_redemption_limit
boolean
default:
false
​
minimum_order_total
integer
default:
0
​
redemption_limit
integer
default:
0
​
require_minimum_order_total
boolean
default:
false
​
segment_id
string[]

required if customer_eligibility = segment

​
tags
string[] | null

Response

200 - application/json
​
content
object
​
message
string
​
success
boolean