Skip to content

Latest commit

 

History

History
27 lines (24 loc) · 3.7 KB

LoyaltiesEarningRulesCreateResponseBody.md

File metadata and controls

27 lines (24 loc) · 3.7 KB
Raw

# LoyaltiesEarningRulesCreateResponseBody

Properties

Name Type Description Notes
id string Assigned by the Voucherify API, identifies the earning rule object. [optional]
createdAt \DateTime Timestamp representing the date and time when the earning rule was created. The value is shown in the ISO 8601 format. [optional]
loyalty \OpenAPI\Client\Model\LoyaltiesEarningRulesCreateResponseBodyLoyalty [optional]
event string [optional]
customEvent \OpenAPI\Client\Model\LoyaltiesEarningRulesCreateResponseBodyCustomEvent [optional]
segment \OpenAPI\Client\Model\LoyaltiesEarningRulesCreateResponseBodySegment [optional]
loyaltyTier \OpenAPI\Client\Model\LoyaltiesEarningRulesCreateResponseBodyLoyaltyTier [optional]
source \OpenAPI\Client\Model\LoyaltiesEarningRulesCreateResponseBodySource [optional]
object string The type of the object represented by JSON. Default is earning_rule. [optional] [default to 'earning_rule']
automationId string For internal use by Voucherify. [optional]
startDate string Start date defines when the earning rule starts to be active. Activation timestamp is presented in the ISO 8601 format. The earning rule is inactive before this date. If you do not define the start date for an earning rule, it will inherit the campaign start date by default. [optional]
expirationDate string Expiration date defines when the earning rule expires. Expiration timestamp is presented in the ISO 8601 format. The earning rule is inactive after this date. If you do not define the expiration date for an earning rule, it will inherit the campaign expiration date by default. [optional]
validityTimeframe \OpenAPI\Client\Model\ValidityTimeframe [optional]
validityDayOfWeek int[] 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 \OpenAPI\Client\Model\ValidityHours [optional]
metadata object The metadata object stores all custom attributes assigned to the earning rule. A set of key/value pairs that you can attach to an earning rule object. It can be useful for storing additional information about the earning rule in a structured format. [optional]
validationRuleId string A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance. [optional]
updatedAt \DateTime Timestamp representing the date and time when the earning rule was last updated in ISO 8601 format. [optional]
active bool A flag to toggle the earning rule on or off. You can disable an earning rule even though it's within the active period defined by the start_date and expiration_date of the campaign or the earning rule's own start_date and expiration_date. - `true` indicates an active earning rule - `false` indicates an inactive earning rule [optional]

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