LoyaltyReward

Reward within a loyalty program that can be added to a member for points.

When updating, already existing fields omitted from the payload will generally not be deleted unless otherwise specified.

Changing the reward type (or Offer ID for Sparkfly Offer Rewards) is not supported, at least with an Update request.

  • display_name
    Type: string
    required

    An identifier for a Reward.

  • name
    Type: string
    required

    An identifier for a Reward.

  • point_value
    Type: integer
    required

    How many points are required to purchase this reward. This should be 0 for Variable Point Offer Rewards.

  • type
    Type: stringenum
    required

    What type of Reward this is. Used to distinguish a Reward that is a Sparkfly Offer from Rewards external to Sparkfly Offers (such as a T-Shirt).

    values
    • non_offer
    • fixed_point_offer
    • variable_point_offer
  • created_at
    Type: stringFormat: date-time
    read-only

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • description
    Type: string

    More details about a Reward.

  • eligible_channel_id
    Type: integer

    If this is an Offer Reward type, the ID of the Sparkfly Campaign.

  • id
    Type: integer
    read-only

    Integer numbers.

  • mobile_image_thumb_url
    Type: string
  • mobile_image_url
    Type: string
  • offer_id
    Type: integer

    If this is an Offer Reward type, the ID of the Sparkfly Offer.

  • offer_value_multiplier
    Type: number

    Required for “variable_point_offer” rewards. The transaction discount (cents for USD) per point spent on the reward. For a discount of 1 dollar off per 5 points spent, this would be set to 20.

  • reward_catalog_id
    Type: integer
    read-only

    Integer numbers.

  • status
    Type: stringenum
    read-only
    values
    • pending
    • active
    • suspended
    • archived
  • terms_and_conditions
    Type: string

    More details about a Reward.

  • updated_at
    Type: stringFormat: date-time
    read-only

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • web_image_thumb_url
    Type: string
  • web_image_url
    Type: string
Examples 
{
  "id": 0,
  "loyalty_reward_catalog_id": 0,
  "name": "string",
  "display_name": "string",
  "description": "string",
  "terms_and_conditions": "string",
  "point_value": 0,
  "type": "fixed_point_offer",
  "offer_id": 0,
  "eligible_channel_id": 0,
  "web_image_url": "string",
  "web_image_thumb_url": "string",
  "mobile_image_url": "string",
  "mobile_image_thumb_url": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}