Skip to content

Latest commit

 

History

History
38 lines (35 loc) · 4.48 KB

CampaignsGetResponseBody.md

File metadata and controls

38 lines (35 loc) · 4.48 KB

# CampaignsGetResponseBody

Properties

Name Type Description Notes
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. [optional]
campaign_type string Type of campaign.
type string 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 \OpenAPI\Client\Model\CampaignVoucher [optional]
auto_join bool Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
join_once bool If this value is set to `true`, customers will be able to join the campaign only once.
use_voucher_metadata_schema bool Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.
validity_timeframe \OpenAPI\Client\Model\CampaignBaseValidityTimeframe [optional]
validity_day_of_week int[] 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]
activity_duration_after_publishing 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]
vouchers_count int Total number of unique vouchers in campaign. [optional]
start_date \DateTime Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. [optional]
expiration_date \DateTime Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. [optional]
active bool 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]
created_at \DateTime Timestamp representing the date and time when the campaign was created in ISO 8601 format.
updated_at \DateTime Timestamp representing the date and time when the voucher was updated in ISO 8601 format. [optional]
category string Unique category name. [optional]
creation_status string Indicates the status of the campaign creation.
vouchers_generation_status string Indicates the status of the campaign's vouchers.
protected bool Indicates whether the resource can be deleted.
category_id string Unique category ID that this campaign belongs to.
categories \OpenAPI\Client\Model\Category[] Contains details about the category.
object string The type of object represented by JSON. This object stores information about the campaign. [default to 'campaign']
referral_program \OpenAPI\Client\Model\ReferralProgram [optional]
loyalty_tiers_expiration \OpenAPI\Client\Model\LoyaltyTiersExpirationAll [optional]
promotion \OpenAPI\Client\Model\PromotionTiersList [optional]
validation_rules_assignments \OpenAPI\Client\Model\ValidationRulesAssignmentsList [optional]

[Back to Model list] [Back to API list] [Back to README]