Hang Platform
  • Introduction
  • Hang Embed
  • Webhooks
    • Use incoming webhooks to get real-time updates
    • Types of events
    • quest_opt_in.updated
    • program_membership.created
    • program_membership.updated
  • API Usage
    • Creating Program Memberships for New Users
    • Search for a program membership
    • Updating Program Memberships for Existing Users
    • Record Activities on a Program Membership
    • Update Traits on a Program Membership
    • Fetching and Opening Loot Boxes for a Program Membership
    • Managing Quests for Program Memberships
    • Managing Redemptions for Program Memberships
    • Retrieving Rewards for Program Memberships
    • Creating and Managing Puzzles
    • Checking applicable Rewards for a Toast cart
    • Posting Orders Through Hang
    • Search for a PartnerApiOrder
    • Retrieving Created or Updated Program Memberships
  • API
    • Overview
    • About
    • API reference
      • Membership
        • Social media credentials
        • Wallets
      • Program memberships
        • Activities
        • Add trait
        • Remove trait
        • Set image
        • Search
        • Level
        • Opt ins
        • Redemptions
        • Rewards
        • Applicable rewards
        • Balance cards
          • Deposit
          • Reverse transaction
        • Loot boxes
          • Open
        • Puzzles
          • Complete
        • Activies
          • Synchronous
        • Quests
          • Opt ins
          • Opt in
      • Users
      • Integrations
        • Search
      • Programs
        • Tiers
      • Admin
        • Program
        • Quests
          • Quest requirements
        • Quest requirements
        • Rewards
          • Batch create
          • Batch update
        • Bingo games
          • Bingo tasks
            • Bulk update
        • Challenges
          • Update status
          • Streak config info
          • Settings config info
        • Integrations
          • Square
            • Disconnect
        • Loot box reward choices
        • Loot box reward probabilities
        • Loot boxes
        • Program memberships
          • Bonus rewards
          • Program and tier rewards
          • Activity history
          • Quest activities
          • Program segments
          • Member actions
            • Grant reward
            • Grant loot box
            • Grant points
            • Activity
        • Program memberships
        • Program segments
          • Members
        • Program stripe accounts
          • Create
        • Program tiers
        • Promotions
        • Puzzle pieces
        • Puzzles
        • Toast takeout orders
          • Refund
      • Opt ins
        • Claim quest prize
        • Claim activity prize
      • Wallets
        • Redemptions
        • Tokens
      • Redemptions
        • Redeem
      • Tokenized rewards
        • Burn
        • Contracts
          • Wallets
      • Tokens
        • Add trait
        • Remove trait
        • Set token image
        • Level
        • Loot boxes
          • Open
      • External
        • Orders
    • Specification
Powered by GitBook
On this page
  1. API
  2. API reference
  3. Admin

Promotions

PreviousProgram tiersNextPuzzle pieces
  • GETEndpoint to return all promoted rewards for a program using the current JWT
  • POSTEndpoint to create a promotion.
  • PATCHEndpoint to update a promotion.

Endpoint to return all promoted rewards for a program using the current JWT

get
Authorizations
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v2/admin/promotions' \
  --header 'X-API-Key: YOUR_API_KEY'
200
{
  "promotions": [
    "text"
  ]
}

Successful response

Endpoint to create a promotion.

post
Authorizations
Body
start_datenumberrequired

When the promotion becomes active, in epoch seconds.

titlestringrequired

Title of the promotion.

descriptionstringoptional

Description of the reward.

end_datenumberoptional

When the promotion is no longer active, in epoch seconds.

image_urlstringoptional

URL of the promotion image.

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/v2/admin/promotions' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'start_date=1&title=text&description=text&end_date=1&image_url=text'
200
{
  "promotion": {
    "id": "text",
    "title": "text",
    "description": "text",
    "reward_id": 1,
    "start_date": 1,
    "end_date": 1
  }
}

Successful response

Endpoint to update a promotion.

patch
Authorizations
Path parameters
promotion_idanyrequired
Body
start_datenumberrequired

When the promotion becomes active, in epoch seconds.

titlestringrequired

Title of the promotion.

descriptionstringoptional

Description of the reward.

end_datenumberoptional

When the promotion is no longer active, in epoch seconds.

image_urlstringoptional

URL of the promotion image.

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PATCH \
  --url '/v2/admin/promotions/{promotion_id}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'start_date=1&title=text&description=text&end_date=1&image_url=text'
200
{
  "promotion": {
    "id": "text",
    "title": "text",
    "description": "text",
    "reward_id": 1,
    "start_date": 1,
    "end_date": 1
  }
}

Successful response