Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Latest commit

 

History

History
24 lines (21 loc) · 3.01 KB

LoyaltiesEarningRulesGetResponseBody.md

File metadata and controls

24 lines (21 loc) · 3.01 KB
Raw

VoucherifySdk::LoyaltiesEarningRulesGetResponseBody

Properties

Name Type Description Notes
id String Assigned by the Voucherify API, identifies the earning rule object.
created_at Time Timestamp representing the date and time when the earning rule was created in ISO 8601 format.
loyalty EarningRuleBaseLoyalty
event EarningRuleEvent [optional]
custom_event EarningRuleBaseCustomEvent [optional]
segment EarningRuleBaseSegment [optional]
source EarningRuleBaseSource
object String The type of object represented by JSON. Default is earning_rule. [default to 'earning_rule']
automation_id String For internal use by Voucherify.
start_date String Start date defines when the earning rule starts to be active. Activation timestamp in ISO 8601 format. Earning rule is inactive before this date. If you don't define the start date for an earning rule, it'll inherit the campaign start date by default. [optional]
expiration_date String Expiration date defines when the earning rule expires. Expiration timestamp in ISO 8601 format. Earning rule is inactive after this date.If you don't define the expiration date for an earning rule, it'll inherit the campaign expiration date by default. [optional]
validity_timeframe EarningRuleBaseValidityTimeframe [optional]
validity_day_of_week Array<Integer> Integer array corresponding to the particular days of the week in which the earning rule is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday [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.
validation_rule_id String A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance.
updated_at Time Timestamp representing the date and time when the earning rule was last updated in ISO 8601 format.
active Boolean 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