Skip to content

Latest commit

 

History

History
39 lines (35 loc) · 4.52 KB

File metadata and controls

39 lines (35 loc) · 4.52 KB

Voucherify.Model.CampaignsVouchersCreateResponseBody

Response body schema for POST v1/campaigns/{campaignId}/vouchers/{code} and POST v1/campaigns/{campaignId}/vouchers.

Properties

Name Type Description Notes
Id string Assigned by the Voucherify API, identifies the voucher. [optional]
Code string A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters. [optional]
Campaign string A unique campaign name, identifies the voucher's parent campaign. [optional]
CampaignId string Assigned by the Voucherify API, identifies the voucher's parent campaign. [optional]
Category string Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint. [optional]
CategoryId string Unique category ID assigned by Voucherify. [optional]
Type string Defines the type of the voucher. [optional]
Discount Discount [optional]
Gift CampaignsVouchersCreateResponseBodyGift [optional]
LoyaltyCard CampaignsVouchersCreateResponseBodyLoyaltyCard [optional]
StartDate DateTimeOffset? Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date. [optional]
ExpirationDate DateTimeOffset? Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date. [optional]
ValidityTimeframe ValidityTimeframe [optional]
ValidityDayOfWeek List<CampaignsVouchersCreateResponseBody.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 [optional]
ValidityHours ValidityHours [optional]
Active bool? A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an active voucher - `false` indicates an inactive voucher [optional]
AdditionalInfo string An optional field to keep any extra textual information about the code such as a code description and details. [optional]
Metadata Object The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. [optional]
Assets VoucherAssets [optional]
IsReferralCode bool? Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. [optional]
CreatedAt DateTimeOffset? Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. [optional]
UpdatedAt DateTimeOffset? Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. [optional]
HolderId string Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify. [optional]
ReferrerId string Unique identifier of the referring person. [optional]
Object string The type of the object represented by JSON. Default is `voucher`. [optional]
Publish CampaignsVouchersCreateResponseBodyPublish [optional]
Redemption CampaignsVouchersCreateResponseBodyRedemption [optional]
Categories List<Category> Contains details about the category. [optional]
ValidationRulesAssignments ValidationRulesAssignmentsList [optional]

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