Skip to main content

Create a Boost campaign

Define the customer action worth rewarding — a sign-up, an upgrade, a first purchase — and the campaign that pays it off.

A Boost campaign ties one target action to a set of rewards. You describe the action and what a completed one is worth to your business; then you attach the incentives customers earn for it, and your product runs the journey through the API.

Campaigns are created and managed in the Paylode admin app — the API's job is the customer journey (teasers, tracking, rewards), not campaign setup. This guide walks the app flow.

Before you begin​

  • You're signed in to the Paylode admin app and can see Boost campaigns in the left navigation.
  • A clear target action. One campaign rewards one action — "create an account", "switch to the annual plan". If you want to reward two different actions, that's two campaigns.
  • A value for a completed action. How much one completed journey is worth to you, in dollars — it drives the business-value figure you'll read later.

Steps​

1. Open Boost campaigns and create​

In the app's left navigation, open Boost campaigns and create a new campaign. A short form describes it:

FieldWhat to put there
Name (required)What your team will recognize in a list — Spring sign-up boost.
DescriptionA sentence on what the campaign does, for teammates.
Action typeThe customer action being rewarded — pick a suggestion or type your own (Create an account).
Completed action valueWhat one completed action is worth to you, in USD. It's an estimate you own — the multiplier behind the business-value number in your statistics, not a payment or a charge.
RepeatabilityWhether one customer can be rewarded once or repeatedly.
Estimated audience sizeRoughly how many customers will meet the campaign, and how often.

Action type and completed action value deserve the most thought — they're what turn the campaign's raw counts into a business-value readout you can defend later.

2. Attach the rewards​

Open the new campaign's Perks tab and add the incentives customers can earn — perks (with or without single-use codes) and gift cards from your funded pools — then rank them so your strongest reward leads. The full walkthrough is Add and rank incentives.

3. Get the integration details​

The campaign's Integration tab carries what your developer needs — the campaign id that every customer-journey API call takes, alongside your API key reference. Hand that over; the path from teaser to redeemed reward is Go live with Boost.

4. Adjust as your plan changes​

Everything above stays editable in the campaign's Settings tab. Pausing — the whole campaign or a single incentive — is its own switch; see Pause a campaign or incentive.

Restrict rewards to trusted networks​

Reward delivery can be pinned to your account's app-level IP whitelist campaign by campaign. Each campaign has an IP-whitelist setting in its settings: switch it on and every reward request for that campaign must come from an address on your app-level list — requests from anywhere else are rejected with 403. The setting has no list of its own; it always enforces the app-level list your account manages under Admin → Security — see Restrict access by IP.

caution

The setting is fail-closed. Once it's on, an empty app-level list doesn't mean "no restriction" — it means no address is trusted, and every reward request for the campaign is blocked with 403. Add your server's egress addresses to the app-level list before switching the setting on.

Once you're live​

The campaign is active once created, so its rewards are reachable right away:

  • Put it in front of customers — Go live with Boost.
  • Watch the results — the campaign's Performance tab shows completed actions and the business value they represent; for your own dashboards, the same data is queryable through Analytics.

Troubleshooting​

note

A campaign with no rewards shows customers nothing. A campaign can exist with an empty reward list — it simply has nothing to serve. Add at least one incentive; if a reward isn't ready yet, add it and pause it until you are.

note

One action per campaign. If teasers show rewards that don't match what the customer is being asked to do, the campaign is probably trying to cover two actions — split it.