Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 3.54 KB

LoyaltiesCreateCampaignRequestBody.md

File metadata and controls

63 lines (43 loc) · 3.54 KB

LoyaltiesCreateCampaignRequestBody

Request body schema for POST /loyalties.

Properties

Name Type Description
name String Campaign name.
description String An optional field to keep any extra textual information about the campaign such as a campaign description and details.
type TypeEnum Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published
joinOnce Boolean If this value is set to `true`, customers will be able to join the campaign only once.
autoJoin Boolean Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
useVoucherMetadataSchema Boolean Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.
vouchersCount Integer Total number of unique vouchers in campaign (size of campaign).
startDate OffsetDateTime Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.
expirationDate OffsetDateTime Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.
validityTimeframe ValidityTimeframe
validityDayOfWeek List<ValidityDayOfWeekEnum> Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday
validityHours ValidityHours
activityDurationAfterPublishing String Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days.
categoryId String Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`.
category String The category assigned to the campaign. Either pass this parameter OR the `category_id`.
metadata Object The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.
validationRules List<String> Array containing the ID of the validation rule associated with the promotion tier.
campaignType CampaignTypeEnum Type of campaign.
voucher CampaignLoyaltyVoucher

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
LOYALTY_PROGRAM "LOYALTY_PROGRAM"