Skip to end of banner
Go to start of banner

reward_offer_validity_short

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

 reward 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_WEEK_MONTH, VALID_DURING_NAME_DAY_WEEK_MONTH, VALID_DURING_RECURRING_PERIOD

 

 

The VALID_DURING_BIRTHDAY_WEEK_MONTH, VALID_DURING_NAME_DAY_WEEK_MONTH, VALID_DURING_RECURRING_PERIOD options are available from CRM.COM R11.1.0 onwards


validity_birthday_periodString

Defines if the offer will be valid during birthday week or birthday month. The supported options are VALID_DURING_BIRTHDAY_WEEK and VALID_DURING_BIRTHDAY_MONTH. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_WEEK_MONTH

 

Available from CRM.COM R11.1.0


validity_name_day_periodString

Defines if the offer will be valid during name day week or name day month. The supported options are VALID_DURING_NAME_DAY_WEEK and VALID_DURING_NAME_DAT_MONTH. Applicable only when the reward offer's validity option is set to VALID_DURING_NAME_DAY_WEEK_MONTH

 

Available from CRM.COM R11.1.0


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

 

Available from CRM.COM R11.1.0


Referred Objects Response Data

 reward_offer_validity_periods response data object
NameType Description
idStringThe ID of the retrieved reward offer validity period
valid_fromDateThe date from which the reward offer will be valid
valid_toDateThe date that the reward offer should become invalid. This is optional as reward offer can be valid for ever, starting from a specific date

 reward_offer_validity_recurring_periods response data object
NameType Description
idStringThe ID of the retrieved reward offer validity recurring period
valid_fromRecurring Period ObjectThe recurring period that the reward offer should become valid.
valid_toRecurring Period ObjectThe recurring period that the reward offer should become invalid.

Referred Objects Response Data

 recurring period object response data

Name

Type

Description

dayInteger

The day of the recurring period which can be from 1 up to 31 (depending on the retrieved month)

month

 

Integer

The month of the recurring period which can be from 1 up to 12

  • No labels