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). Otherwhise, 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 Status | API Response | Definition |
|---|---|---|
| Enabled | enabled | Rewards delivery is authorized. |
| Paused | paused | Promotion is paused and might resume. Codes can't be retrieved or sent. |
| Completed | completed | Promotion is done. Codes can't be retrieved or sent. |
| Deleted | disabled | Promotion 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 States | API Response | Definition |
|---|---|---|
| Ready | ready | All checks are green. If the promotion is enabled, rewards delivery is allowed. Codes can be retrieved or sent. |
| Pending | pending | The start date of the promotion is in the future. Codes can't be retrieved or sent. |
| Ended | ended | The end date of the promotion is past. Codes can't be retrieved or sent. |