Skip to content

Campaign.md

Latest commit

 

History

History
126 lines (67 loc) · 6.57 KB

Campaign.md

File metadata and controls

126 lines (67 loc) · 6.57 KB
Raw

Voucherify.Campaign

Properties

Name Type Description Notes
id String Unique campaign ID, assigned by Voucherify. [optional]
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]
campaignType String Type of campaign. [optional]
type String Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers [optional]
voucher CampaignVoucher [optional]
autoJoin Boolean Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. [optional]
joinOnce Boolean If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always `true` for loyalty campaigns and it cannot be changed in them. [optional]
useVoucherMetadataSchema Boolean Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. [optional]
validityTimeframe ValidityTimeframe [optional]
validityDayOfWeek [Number] 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 [optional]
validityHours ValidityHours [optional]
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. [optional]
vouchersCount Number Total number of unique vouchers in campaign. [optional]
startDate Date Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. [optional]
expirationDate Date Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. [optional]
active Boolean A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an active campaign - `false` indicates an inactive campaign [optional]
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. [optional]
createdAt Date Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. [optional]
updatedAt Date Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. [optional]
category String Unique category name. [optional]
creationStatus String Indicates the status of the campaign creation. [optional]
vouchersGenerationStatus String Indicates the status of the campaign's voucher generation. [optional]
readonly Boolean Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. It is also not returned for restricted users who use the GET Campaign summary endpoint. [optional]
_protected Boolean Indicates whether the resource can be deleted. [optional]
categoryId String Unique category ID that this campaign belongs to. [optional]
categories [Category] Contains details about the campaign category. For the GET List campaigns endpoint, this is returned only if the `expand=category` query parameter is passed in the request. Otherwise, it is returned as an empty array. For GET Campaign summary endpoint, it is always returned as an empty array. [optional]
object String The type of the object represented by JSON. This object stores information about the campaign. [optional] [default to 'campaign']
referralProgram ReferralProgram [optional]
loyaltyTiersExpiration LoyaltyTiersExpirationAll [optional]
accessSettingsAssignments AccessSettingsCampaignAssignmentsList [optional]
promotion PromotionTiersList [optional]
validationRulesAssignments ValidationRulesAssignmentsList [optional]

Enum: CampaignTypeEnum

  • LOYALTY_PROGRAM (value: "LOYALTY_PROGRAM")

  • GIFT_VOUCHERS (value: "GIFT_VOUCHERS")

  • DISCOUNT_COUPONS (value: "DISCOUNT_COUPONS")

  • PROMOTION (value: "PROMOTION")

  • REFERRAL_PROGRAM (value: "REFERRAL_PROGRAM")

Enum: TypeEnum

  • AUTO_UPDATE (value: "AUTO_UPDATE")

  • STATIC (value: "STATIC")

  • STANDALONE (value: "STANDALONE")

Enum: [ValidityDayOfWeekEnum]

  • 0 (value: 0)

  • 1 (value: 1)

  • 2 (value: 2)

  • 3 (value: 3)

  • 4 (value: 4)

  • 5 (value: 5)

  • 6 (value: 6)

Enum: CreationStatusEnum

  • DONE (value: "DONE")

  • IN_PROGRESS (value: "IN_PROGRESS")

  • FAILED (value: "FAILED")

  • DRAFT (value: "DRAFT")

  • MODIFYING (value: "MODIFYING")

Enum: VouchersGenerationStatusEnum

  • DONE (value: "DONE")

  • IN_PROGRESS (value: "IN_PROGRESS")

  • FAILED (value: "FAILED")

  • DRAFT (value: "DRAFT")

  • MODIFYING (value: "MODIFYING")