- Platform Overview
- Resources and Guides
-
POS Integration
-
Getting Started
-
Core Concepts
-
Integration SDK
-
Certification
-
- Order Ahead
-
Provider Enablement
-
Provider Enablement
-
Endpoints
-
Developer Endpoints
-
-
API Reference
-
Getting Started
-
v15
-
- Access Tokens
- Campaigns
- Credit Cards
- Users
- Credit
- Locations
- Payment Methods
- QR Codes
- Progress Adjustments
- Orders
- Rewards
- Gift Cards
-
-
v14
-
- Credit
- Access Tokens
- Campaigns
- Categories
- Credit Cards
- Interstitials
- Locations
- Loyalty
- Orders
- Payment Tokens
- Support Tickets
- Users
-
-
Campaigns .: Claim
API Reference / v14
Claim a Campaign
This endpoint claims a campaign via a cohort code.
Request Endpoint
POST /v14/codes/:code/claims
Authorization Required – User Token in Header
Authorization: token 123456-75489120749...
cURL Example
curl -X POST https://api.thelevelup.com/v14/codes/1234/claims
Responses
Success
HTTP/1.1 200 OK
{
"claim": {
"id": 123,
"campaign_id": 6675,
"code": "code_you_claimed",
"value_amount": 1000,
"value_remaining_amount": 1000
}
}
The campaign does not exist
HTTP/1.1 404 Not Found
[
{
"error": {
"object": "claim",
"property": "base",
"message": "This doesn't appear to be a LevelUp Code."
}
}
]
If the campaign is not claimable for any reason
HTTP/1.1 422 Unprocessable Entity
[
{
"error": {
"object": "claim",
"property": "base",
"message": "Sorry, you cannot claim this promotion at this time."
}
}
]