Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titlereward offer validity object response data

Name

Type

Description

validity_optionsString

Defines the reward offer's validity options. The available values are VALID_FROM_LATEST_EFFECTIVE_DATE and VALID_FOR_SPECIFIC_PERIOD, VALID_DURING_BIRTHDAY_PERIOD, VALID_DURING_NAME_DAY_PERIOD, VALID_DURING_RECURRING_PERIOD

Tip

The VALID_DURING_BIRTHDAY_PERIOD, VALID_DURING_NAME_DAY_PERIOD, VALID_DURING_RECURRING_PERIOD options are available from CRM.COM R11.1.0 onwards


valid_x_days_before_birthday_dateInteger

Defines the number of days before the birthday date during which the offer will become valid. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_PERIOD

Tip

Available from CRM.COM R11.1.0


valid_x_days_after_birthday_dateInteger

Defines the number of days after the birthday date during which the offer will become invalid. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_PERIOD

Tip
 Available from CRM.COM R11.1.0
valid_x_days_before_name_day_dateInteger

Defines the number of days before the name day date during which the offer will become valid. Applicable only when the reward offer's validity option is set to VALID_DURING_NAME_DAY_PERIOD

Tip

Available from CRM.COM R11.1.0


valid_x_days_after_name_day_dateInteger

Defines the number of days after the name day date during which the offer will become invalid. Applicable only when the reward offer's validity option is set to VALID_DURING_NAME_DAY_PERIOD 

Tip
 Available from CRM.COM R11.1.0
valid_fromDate

The date from which the reward offer will be valid. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_PERIOD or VALID_DURING_NAME_DAY_PERIOD 

 

Tip
 Available from CRM.COM R12.4.5


 

valid_toDate

The date that the reward offer should become invalid. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_PERIOD or VALID_DURING_NAME_DAY_PERIOD 

Tip
 Available from CRM.COM R12.4.5
validity_periods_setSet of Reward Offer Validity Period objectsThe periods during which the retrieved reward offer will be valid. Applicable only when the reward offer's validity option is set to VALID_FOR_SPECIFIC_PERIOD.
validity_recurring_periods_setSet of Reward Offer Validity Recurring Period objects

The recurring periods during which the retrieved reward offer will be valid. Applicable only when the reward offer's validity option is set to VALID_DURING_RECURRING_PERIOD

Tip

Available from CRM.COM R11.1.0


Anchor
reward offer validity referred objects
reward offer validity referred objects
Referred Objects Response Data

Include Page
reward_offer_validity_periods_short
reward_offer_validity_periods_short

Include Page
reward_offer_validity_recurring_periods_short
reward_offer_validity_recurring_periods_short