Skip to main content

Pause a campaign or incentive

Turn a reward off without deleting it — a whole campaign at once, or a single incentive within one — and turn it back on when you're ready.

Pausing is the reversible off switch. Nothing is deleted, statistics are kept, and flipping the status back to active restores everything exactly as it was. Use it to stage a campaign before launch, take a reward down while you sort out a problem, or wind a promotion down without losing its history.

There are two levels:

  • Campaign — pause the whole thing. No teasers or rewards are served.
  • Incentive — pause one reward inside an otherwise-running campaign.

How it works​

Both a campaign and an incentive have a status of ACTIVE or PAUSED, and they're independent — pausing one incentive doesn't touch the campaign, and pausing the campaign doesn't change each incentive's own status.

  • A paused campaign stops serving entirely. Teasers and rewards return 409 while it's paused, so customers reaching it get nothing until you resume. Because a paused campaign returns 409 rather than an empty result, you can detect and message the state in your integration if you want to.
  • A paused incentive just drops out. Only active incentives appear in a campaign's rewards, so a paused one is simply not shown — the rest of the campaign runs normally.
  • Paylode can pause a gift-card incentive for you. When a gift-card incentive's pool runs out of cards for its denomination and currency, the incentive is automatically paused so customers never reach a reward that can't be delivered. It's the same paused status you set by hand — top up the pool, then switch the incentive back to active.

Resuming is the same call with ACTIVE.

Before you begin​

  • You're signed in to the Paylode admin app with the campaign open under Boost campaigns.

Steps​

Pause a whole campaign​

On the campaign, switch its status to paused. While a campaign is paused it serves nothing — a customer reaching it gets no teasers and no rewards (your integration sees a 409 response, so you can detect and message the state if you want to). Flip it back to active the same way; the campaign picks up right where it left off.

Pause a single incentive​

On the campaign's Perks tab, each incentive has its own active/paused switch. A paused incentive stays attached and ranked but no longer appears in the campaign's rewards — the rest of the campaign runs normally. Switch it back to active when you're ready.

Once you're live​

Common patterns:

  • Stage before launch — create a campaign, then pause it until you're ready to show customers, and flip it to active at go time.
  • Take one reward down — pause a single incentive while you fix a problem (for example a perk whose pool ran empty), leaving the rest of the campaign live.
  • Wind down cleanly — pause a finished promotion instead of deleting it, so its statistics stay readable on the campaign's Performance tab and in Boost performance.

Troubleshooting​

caution

Customers hit a 409 on a paused campaign. That's expected — a paused campaign serves no teasers or rewards. If customers should be seeing rewards, set the campaign back to active in the app.

note

Pausing the last active incentive empties the campaign. The campaign stays active, but with no active incentive its rewards come back empty. If you're taking a reward down, keep at least one other incentive active — or pause the whole campaign instead.

note

A newly added incentive starts active. Add it, then pause it on the Perks tab if it isn't ready to show. See Add and rank incentives.

note

A gift-card incentive paused itself. That's the automatic pause: its pool ran out of cards. If the incentive has a low-inventory threshold, a warning went out before it emptied — over your shared Slack channel if your client success manager has set one up, otherwise to your client success manager, who will reach out. Top up the pool, then set the incentive back to active. See Add and rank incentives.