Data model description
The loyalty campaign object contains details about the loyalty campaign. You can list loyalty campaigns, list loyalty card holders, member activities, active rewards, earning rules, loyalty tiers for given loyalty campaign.
Attributes | Description | Example |
---|---|---|
id | System generated campaign id. |
|
name | Campaign name. |
|
campaign_type | Default campaign type for loyalty campaign is |
|
type | Campaign's type. Voucherify offers two types:
|
|
description | A field to keep any extra textual information. | |
start_date | When the campaign begins. Before this date loyalty cards are inactive. |
|
expiration_date | When the campaign ends. After this date loyalty cards are inactive. |
|
activity_duration_after_publishing | Loyalty cards can be active for a specific time frame after publishing. | |
validity_timeframe | You can set recurrent time periods when the loyalty cards are valid. | |
validity_day_of_week | Integer array corresponding to the particular days of the week that the loyalty campaign is valid. Sunday - |
|
metadata | Object with custom attributes assigned to the campaign as metadata. | |
created_at | Timestamp of loyalty campaign object creation. |
|
vouchers_count | The size of the list of vouchers generated for the loyalty campaign. |
|
vouchers_generation_status | Shows if the loyalty cards are already created and ready to use. |
|
active | A flag that allows to disable a campaign. |
|
voucher | A description of the vouchers collected in the loyalty campaign. It contains the entire voucher definition which is used to generate unique codes during the campaign creation. The same parameters are used when you add new codes after the campaign creation date. |
|
validation_rules_assignments |
| |
auto_join | Optional campaign mode ensuring that when a customer meets at least one earning rule, he/she will automatically get a loyalty card published (assigned) to his/her profile with an updated points balance. |
|
join_once | Optional campaign mode ensuring that each customer can own only one loyalty card from the campaign. |
|
use_voucher_metadata_schema |
|