Skip to main content
POST
Create Promotion

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
name
string
required
description
string | null
startDate
string<date-time> | null
endDate
string<date-time> | null
rrule
string | null
timezone
string | null
maxRedemptions
integer | null
Required range: x >= 1
maxPerPatient
integer | null
Required range: x >= 1
autoApply
boolean
default:true
code
string | null
creditAmount
integer | null
Required range: x >= 0
creditExpiryDays
integer | null
Required range: x >= 1
loyaltyPointsBonus
integer | null
Required range: x >= 1
loyaltyPointsExpiryDays
integer | null
Required range: x >= 1
providerIds
string[]
teamIds
string[]
rules
PromotionRuleCreate · object[]
discountTemplates
PromotionDiscountTemplateCreate · object[]

Response

Successful Response

id
string
required
name
string
required
isActive
boolean
required
description
string | null
startDate
string<date-time> | null
endDate
string<date-time> | null
rrule
string | null
timezone
string | null
maxRedemptions
integer | null
maxPerPatient
integer | null
redemptionsCount
integer
default:0
autoApply
boolean
default:true
code
string | null
creditAmount
integer | null
creditExpiryDays
integer | null
loyaltyPointsBonus
integer | null
loyaltyPointsExpiryDays
integer | null
providerIds
string[]
teamIds
string[]
createdDate
string<date-time> | null
updatedDate
string<date-time> | null
rules
PromotionRuleSummary · object[]
discountTemplates
PromotionDiscountTemplateSummary · object[]