Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 4.09 KB

LoyaltiesMembersTransfersCreateResponseBody.md

File metadata and controls

59 lines (43 loc) · 4.09 KB
Raw

LoyaltiesMembersTransfersCreateResponseBody

Response body schema for POST /loyalties/{campaignId}/members/{memberId}/transfers.

Properties

Name Type Description Notes
id String Assigned by the Voucherify API, identifies the voucher.
code String A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.
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]
categories List<Category> [optional]
type TypeEnum Defines the type of the voucher.
loyaltyCard LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard
startDate OffsetDateTime Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date. [optional]
expirationDate OffsetDateTime Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date. [optional]
validityTimeframe LoyaltiesMembersTransfersCreateResponseBodyValidityTimeframe [optional]
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 [optional]
validityHours ValidityHours [optional]
publish LoyaltiesMembersTransfersCreateResponseBodyPublish [optional]
redemption LoyaltiesMembersTransfersCreateResponseBodyRedemption [optional]
active String 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
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.
assets LoyaltiesMembersTransfersCreateResponseBodyAssets [optional]
isReferralCode Boolean Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`.
holderId String Unique identifier of the customer who owns the voucher. [optional]
updatedAt OffsetDateTime Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. [optional]
createdAt OffsetDateTime

Enum: TypeEnum

Name Value
LOYALTY_CARD "LOYALTY_CARD"

Enum: List<ValidityDayOfWeekEnum>

Name Value
NUMBER_0 0
NUMBER_1 1
NUMBER_2 2
NUMBER_3 3
NUMBER_4 4
NUMBER_5 5
NUMBER_6 6