Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 3.29 KB

LoyaltiesEarningRulesEnableResponseBody.md

File metadata and controls

52 lines (36 loc) · 3.29 KB

LoyaltiesEarningRulesEnableResponseBody

Response body schema for POST /loyalties/{campaignId}/earning-rules/{earningRuleId}/enable

Properties

Name Type Description Notes
id String Assigned by the Voucherify API, identifies the earning rule object.
createdAt OffsetDateTime Timestamp representing the date and time when the earning rule was created. The value is shown in the ISO 8601 format.
loyalty EarningRuleBaseLoyalty
event EarningRuleEvent [optional]
customEvent EarningRuleBaseCustomEvent [optional]
segment EarningRuleBaseSegment [optional]
source EarningRuleBaseSource
_object ObjectEnum The type of the object represented by JSON. Default is earning_rule.
automationId String For internal use by Voucherify.
startDate String Start date defines when the earning rule starts to be active. Activation timestamp is presented in the 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]
expirationDate String Expiration date defines when the earning rule expires. Expiration timestamp is presented in the 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]
validityTimeframe EarningRuleBaseValidityTimeframe [optional]
validityDayOfWeek List<ValidityDayOfWeekEnum> 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]
validityHours 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.
updatedAt OffsetDateTime Timestamp representing the date and time when the earning rule was last updated in ISO 8601 format. [optional]
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.

Enum: ObjectEnum

Name Value
EARNING_RULE "earning_rule"

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