create-loyalty-promotion-request.md

Create Loyalty Promotion Request

Represents a CreateLoyaltyPromotion request.

Structure

CreateLoyaltyPromotionRequest

Fields

Name	Type	Tags	Description
loyaltyPromotion	LoyaltyPromotion	Required	Represents a promotion for a loyalty program. Loyalty promotions enable buyers to earn extra points on top of those earned from the base program. A loyalty program can have a maximum of 10 loyalty promotions with an ACTIVE or SCHEDULED status.
idempotencyKey	string	Required	A unique identifier for this request, which is used to ensure idempotency. For more information, see Idempotency. Constraints: Minimum Length: 1, Maximum Length: 128

Example (as JSON)

{
  "idempotency_key": "ec78c477-b1c3-4899-a209-a4e71337c996",
  "loyalty_promotion": {
    "available_time": {
      "time_periods": [
        "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT"
      ]
    },
    "incentive": {
      "points_multiplier_data": {
        "points_multiplier": 3
      },
      "type": "POINTS_MULTIPLIER"
    },
    "name": "Tuesday Happy Hour Promo",
    "trigger_limit": {
      "interval": "DAY",
      "times": 1
    }
  }
}