Campaign
Sevenheaven Campaign Management API
Sevenheaven provides a set of API endpoints to effectively manage your campaigns. These endpoints allow you to transition between different campaign states, enabling dynamic control over your campaigns.
Campaign States
Draft: The initial state after creating a campaign. Not yet active.
Active: The campaign is ready to distribute rewards to users who meet the specified conditions.
Paused: The campaign is temporarily halted. Users cannot claim rewards from a paused campaign.
Canceled: The campaign is completely canceled. The cancellation state is an irreversible terminal condition.
Completed: The campaign has fulfilled the specified duration or conditions and has ended.
Pause a Campaign
To pause a specific campaign, you can use the following request:
This request temporarily pauses the campaign, and users cannot claim rewards from a paused campaign. The campaign data remains intact and can be resumed at any time.
Resume a Campaign
To resume a paused campaign, use the following request:
This request activates the paused campaign, allowing users to participate again and claim rewards.
Cancel a Campaign
To cancel a specific campaign, you can use the following request:
The cancellation request stops the campaign, and the campaign data is preserved until you decide to delete the campaign. Canceled campaigns cannot be restarted.
These API endpoints empower you to dynamically manage your Sevenheaven campaigns. Each action allows you to change the state of a specific campaign and intervene in your campaigns as needed.
Last updated