| id |
String |
Unique campaign ID, assigned by Voucherify. |
| 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. |
| campaignType |
CampaignTypeEnum |
Type of campaign. |
| type |
TypeEnum |
Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published |
| voucher |
LoyaltyCampaignVoucher |
|
| autoJoin |
Boolean |
Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. |
| joinOnce |
Boolean |
If this value is set to `true`, customers will be able to join the campaign only once. |
| useVoucherMetadataSchema |
Boolean |
Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. |
| 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 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. |
| vouchersCount |
Integer |
Total number of unique vouchers in 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. |
| 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 |
| 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. |
| createdAt |
OffsetDateTime |
Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. |
| updatedAt |
OffsetDateTime |
Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. |
| category |
String |
Unique category name. |
| creationStatus |
CreationStatusEnum |
Indicates the status of the campaign creation. |
| vouchersGenerationStatus |
VouchersGenerationStatusEnum |
Indicates the status of the campaign's voucher generation. |
| 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. |
| _protected |
Boolean |
Indicates whether the resource can be deleted. |
| categoryId |
String |
Unique category ID that this campaign belongs to. |
| categories |
List<Category> |
Contains details about the category. |
| _object |
String |
The type of the object represented by JSON. This object stores information about the campaign. |
| loyaltyTiersExpiration |
LoyaltyTiersExpirationAll |
|
| validationRulesAssignments |
ValidationRulesAssignmentsList |
|
| accessSettingsAssignments |
AccessSettingsCampaignAssignmentsList |
|