Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 4.13 KB

CampaignsCreateRequestBody.md

File metadata and controls

70 lines (50 loc) · 4.13 KB
Raw

CampaignsCreateRequestBody

Properties

Name Type Description Notes
name String Campaign name. [optional]
description String An optional field to keep any extra textual information about the campaign such as a campaign description and details. [optional]
type TypeEnum Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). - `STATIC`: vouchers need to be manually published. [optional]
joinOnce Boolean If this value is set to `true`, customers will be able to join the campaign only once. [optional]
autoJoin Boolean Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. [optional]
useVoucherMetadataSchema Boolean Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. [optional]
vouchersCount Integer Total number of unique vouchers in campaign (size of campaign). [optional]
startDate OffsetDateTime Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. [optional]
expirationDate OffsetDateTime Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. [optional]
validityTimeframe CampaignsCreateRequestBodyValidityTimeframe [optional]
validityDayOfWeek List<ValidityDayOfWeekEnum> Integer array corresponding to the particular days of the week in which the campaign is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday [optional]
validityHours ValidityHours [optional]
activityDurationAfterPublishing String Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a `duration` of `P24D` will be valid for a duration of 24 days. [optional]
validationRules List<String> Array containing the ID of the validation rule associated with the promotion tier. [optional]
categoryId String Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. [optional]
category String The category assigned to the campaign. Either pass this parameter OR the `category_id`. [optional]
metadata Object [optional]
campaignType CampaignTypeEnum [optional]
voucher CampaignsCreateRequestBodyVoucher [optional]
referralProgram ReferralProgram [optional]
promotion CampaignsCreateRequestBodyPromotion [optional]
luckyDraw LuckyDraw [optional]

Enum: TypeEnum

Name Value
AUTO_UPDATE "AUTO_UPDATE"
STATIC "STATIC"

Enum: List<ValidityDayOfWeekEnum>

Name Value
NUMBER_0 0
NUMBER_1 1
NUMBER_2 2
NUMBER_3 3
NUMBER_4 4
NUMBER_5 5
NUMBER_6 6

Enum: CampaignTypeEnum

Name Value
DISCOUNT_COUPONS "DISCOUNT_COUPONS"
REFERRAL_PROGRAM "REFERRAL_PROGRAM"
GIFT_VOUCHERS "GIFT_VOUCHERS"
LOYALTY_PROGRAM "LOYALTY_PROGRAM"
PROMOTION "PROMOTION"
LUCKY_DRAW "LUCKY_DRAW"