This endpoint returns a list of campaigns available for customers to participate in. If you provide a particular customer we can return their current status and eligibility on each of the campaigns.
Campaign Parameters Response
Unique campaign id
Information on how to complete the campaign.
One of the various campaign types, such as: SpendBasedCampaign, TransactionBasedCampaign, ReferralCampaign, TwitterRetweetCampaign, InstagramFollowCampaign, TwitterTweetCampaign, TwitterFollowCampaign, etc.
The text found on the button to participate in the campaign e.g. “Tweet”, “Follow”, etc.
Message to be shared on social media, used in the TwitterTweetCampaign.
Campaign dependent. Sometimes a destination to link to from call-to-action button, for TwitterTweet it’s a url to be included in the tweet.
Campaign dependent. For TwitterFollowCampaign, it’s the Twitter handle to follow.
Campaign dependent. For TwitterRetweetCampaign, it’s the tweet id to retweet.
Image used for campaign. If it’s a URL, then it’s an image. Otherwise, it’s a Font Awesome class name.
Describes what the customer gets for completing (e.g. “500 Points”).
Timestamp indicating when this campaign was created.
Timestamp reflecting the last update to this campaign.
The maximum number of times a single customer can complete this campaign.
The number of actions (for punch card style campaigns) that are required for the campaign to be completed.