Skip to main content

Reward Assignment

All of:
  1. Reward Assignment Base
  2. Digital or Material Reward - Parameters

Reward Assignment Base

AttributesDescription
idstringUnique reward assignment ID, assigned by Voucherify.Example:rewa_PbIRoMXpwe5QhobW4JKu0VjH
reward_idstringAssociated reward ID.Example:rew_C7wS9eHFDN4CIbXI5PpLSkGY
created_atstringTimestamp representing the date and time when the reward assignment was created. The value is shown in the ISO 8601 format.Example:2022-08-11T14:49:22.586Z
updated_atstring, nullTimestamp representing the date and time when the reward assignment was updated. The value is shown in the ISO 8601 format.Example:2022-08-11T16:01:34.885Z
objectstringThe type of the object represented by the JSON. This object stores information about the reward assignment.Available values: reward_assignment
related_object_idstringRelated object ID to which the reward was assigned.Example:camp_wciTvaOfYmAa3EmIIW3QpXXZ
related_object_typestringRelated object type to which the reward was assigned.Available values: campaign

Digital or Material Reward - Parameters

AttributesDescription
parametersobjectDefines the cost of the reward.Attributes Descriptionloyaltyobject Defines the equivalent points value of the reward. Attributes Descriptionpointsinteger The number of points required to redeem the reward. auto_redeemboolean, null Determines if the reward is redeemed automatically when the customer reaches the sufficient number of points to redeem it. Value true means that the automatic reward redemption is active. Only one reward can be set to be redeemed automatically in a loyalty campaign, i.e. only one can have the value true.
I