- 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
- Get Details
- Claim
- Get by Cohort
- Claim Legacy
- Get Merchant ID
- Get Image
- Categories
- Credit Cards
- Interstitials
- Locations
- Loyalty
- Orders
- Payment Tokens
- Support Tickets
- Users
-
-
Campaigns .: Get Details
API Reference / v14
Get Campaign Details
This endpoint retrieves details about a campaign.
Request Endpoint
GET /v14/campaigns/:id
No Authorization Required
Request Parameters
Parameters | Type | Description |
---|---|---|
id |
Integer | The LevelUp Campaign ID |
cURL Example
curl https://api.thelevelup.com/v14/campaigns/2
Example Response Body
{
"campaign": {
"applies_to_all_merchants": true,
"confirmation_html": "You just unlocked $2 by scanning a LevelUp Code on a LevelUp business card!",
"id": 2,
"message_for_email_body": "I just grabbed $2.00 to spend on LevelUp. Grab yours too by clicking here https://www.thelevelup.com/c/EM-UPZVX0",
"message_for_email_subject": "Grab $2.00 on LevelUp",
"message_for_facebook": "I claimed $2.00 to spend on LevelUp. Jealous? Click here, claim yours.",
"message_for_twitter": "I just grabbed $2.00 to spend on LevelUp. Grab yours too by clicking here",
"name": "LevelUp Business Card",
"offer_html": "Grab $2 by scanning a LevelUp Code on a LevelUp business card!",
"type": "custom",
"share_url_email": "https://www.thelevelup.com/c/EM-UPZVX0",
"share_url_facebook": "https://www.thelevelup.com/c/FB-UOABTI",
"share_url_twitter": "https://www.thelevelup.com/c/TW-4937B0",
"sponsor": "LevelUp",
"shareable": true,
"value_amount": 200
}
}
Response Parameters
Parameters | Type | Description |
---|---|---|
applies_to_all_merchants |
Boolean | Defines if the campaign is global or fixed to a merchant |
confirmation_html |
String | Text that is displayed when campaign is claimed. |
id |
Integer | LevelUp ID of the campaign. |
message_for_email_body |
String | Email body text. |
message_for_email_subject |
String | Email subject text. |
message_for_facebook |
String | Facebook text. |
message_for_twitter |
String | Twitter text. |
name |
String | Campaign name. |
offer_html |
String | Campaign offer information. |
type |
String | Campaign type. |
share_url_email |
String | URL to share campaign by email. |
share_url_facebook |
String | URL to share campaign on Facebook. |
share_url_twitter |
String | URL to share campaign on Twitter. |
sponsor |
String | Campaign sponsor. |
shareable |
Boolean | Defines if the campaign is shareable or not. |
value_amount |
Integer | Value of the campaign claim. |
Errors
HTTP/1.1 404 Not Found
- The campaign does not exist
(No response body.)