Skip to content

Latest commit

 

History

History
29 lines (25 loc) · 3.63 KB

File metadata and controls

29 lines (25 loc) · 3.63 KB

Voucherify.Model.VouchersCreateRequestBody

Properties

Name Type Description Notes
Code string Code that identifies a voucher. The pattern can use all the letters of the English alphabet, Arabic numerals, and special characters. Pass this attribute in the request body to create a distinct code. Otherwise, either use the `code_config` object to set the rules that the Voucherify API will use to create a random code, or don't pass any code and Voucherify will generate a random code. [optional]
Campaign string Identifies the voucher's parent campaign using a unique campaign name. [optional]
CampaignId string Identifies the voucher's parent campaign using a unique campaign ID assigned by the Voucherify API. [optional]
Category string The name of the category that this voucher belongs to. Useful when listing vouchers with the List Vouchers endpoint. [optional]
CategoryId string Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to. Useful when listing vouchers with the List Vouchers endpoint. [optional]
StartDate DateTimeOffset? Start date defines when the code starts to be active. Activation timestamp is presented in the ISO 8601 format. Voucher is inactive before this date. [optional]
ExpirationDate DateTimeOffset? Expiration date defines when the code expires. Expiration timestamp is presented in the ISO 8601 format. Voucher is inactive after this date. [optional]
ValidityTimeframe ValidityTimeframe [optional]
ValidityDayOfWeek List<VouchersCreateRequestBody.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]
ValidationRules List<string> Array containing the ID of the validation rule associated with the voucher. [optional]
Redemption VouchersCreateRequestBodyRedemption [optional]
Type string [optional]
LoyaltyCard SimpleLoyaltyCard [optional]
CodeConfig CodeConfig [optional]
Gift Gift [optional]
Discount Discount [optional]

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