A Promotion represents the settings of a campaign in which a Client distributes Rewards to the end-users.

Enabled & Ready

In order to allow the rewards distribution, a promotion should have the status "enabled" and the state "ready" (ie, you've received the approval from the platform). Otherwise, the rewards delivery is not possible: codes can't be retrieved or sent.

Promotion status

The status is manually set by an admin to enable or disable the reward delivery as part of a promotion.

Promotion StatusAPI ResponseDefinition
EnabledenabledRewards delivery is authorized.
PausedpausedPromotion is paused and might resume. Codes can't be retrieved or sent.
CompletedcompletedPromotion is done. Codes can't be retrieved or sent.
DeleteddisabledPromotion was a test or created by mistake. Codes can't be retrieved or sent.

Promotion state

The state tells you whether your promotion has everything finalized and approved for deployment.

Promotion StatesAPI ResponseDefinition
ReadyreadyAll checks are green. If the promotion is enabled, rewards delivery is allowed. Codes can be retrieved or sent.
PendingpendingThe start date of the promotion is in the future. Codes can't be retrieved or sent.
EndedendedThe end date of the promotion is past. Codes can't be retrieved or sent.

Offers

Promotions give you a list of offers which represents the list of rewards available on your account.

Each offer has a status and a state that you must check before selling them.

🚧

Codes can be retrieved only if status is enabled and state is ready or no_allocation.

Offer status

The status is manually set by an admin to enable or disable the reward delivery as part of a promotion.

Promotion StatusAPI ResponseDefinition
EnabledenabledRewards delivery is authorized.
PausedpausedOffer is paused and might resume. Codes can't be retrieved or sent.
DisableddisabledOffer has been disabled on your account. The reward will probably no longer be sellable.

Offer state

The state tells you whether your promotion has everything finalized and approved for deployment.

Promotion StatesAPI ResponseDefinition
ReadyreadyAll checks are green. If the offer is enabled, rewards delivery is allowed. Codes can be retrieved or sent.
No allocationno_allocationReward not yet configured for your account, but it can still be redeemed.
Invalid rewardinvalid_reward or invalid_reward_for_redemption_flowProduct misconfigured (Ifeelgoods issue, ask your account manager).