Skip to content

Redeem Code

POST /v1/campaigns/{slug}/redeem

Redeems a campaign code. The code is atomically marked as redeemed and the associated points are deducted from the campaign budget. Each code can only be redeemed once.

HeaderRequiredValue
X-API-SecretYesYour secret key
Content-TypeYesapplication/json
FieldTypeRequiredDescription
codestringYesThe code to redeem (e.g., SUMM-AX7K9M2P)
Terminal window
curl -X POST https://api.gamifyhost.com/v1/campaigns/summer-promo/redeem \
-H "X-API-Secret: sk_live_your_secret_key" \
-H "Content-Type: application/json" \
-d '{ "code": "SUMM-AX7K9M2P" }'

Status: 200 OK

{
"status": "success",
"data": {
"pointsEarned": 500,
"campaignName": "Summer Promo 2025",
"campaignSlug": "summer-promo",
"message": "Successfully redeemed 500 points"
}
}
FieldTypeDescription
pointsEarnedintegerPoints awarded from this code
campaignNamestringCampaign name
campaignSlugstringCampaign slug
messagestringHuman-readable result message
CodeMessage
400invalid or expired code — Code not found or belongs to another partner
400code has already been redeemed — Code was already used
400campaign is not active — Campaign is paused
400campaign has ended — Campaign end date has passed