Create New Campaign
To create a campaign, navigate to Growth → Campaigns on the Payram Dashboard.
1. Define Campaign Settings
Set up the basic details of your campaign:
Select the project, name, description, time period, and budget.
Campaigns and their events are project-specific and do not work across multiple projects.
User registrations are also project-specific, tied to the project’s API key.
The campaign duration can start immediately or at a future date.
If the campaign exceeds the budget, it will automatically shut down.
2. Configure Trigger Events
Define the event that determines when the campaign is considered successful. Events must be configured and triggered via the Payram API from your website.
2.1. Events with Amount
Used for commission-based rewards on sales.
The merchant must send the transaction amount via API.
Supports flat rewards and various frequency types (e.g., one-time, recurring).
Only a single event can be triggered per campaign using this method.
2.2. Events without Amount
Cannot include commission-based rewards.
Useful for multi-criteria reward triggers.
Allows multiple events to be triggered in a single campaign.
2.3. Multi-Event Campaigns
Supports multi-step campaigns where different actions trigger a reward.
Only flat rewards are allowed (no commission-based rewards).
Rewards must follow a single frequency type (e.g., one-time only).
💡 Note: Save the event key you create, as it will be required to trigger events in the next step.
3. Set Up Rewards
Merchants define the rewards for referrers and referees once a campaign event is completed.
Choose between flat rewards or commission-based rewards (with individual payout limits).
At least one party (referrer or referee) must receive a non-zero reward for the campaign to be valid.
Set reward frequency:
One-time
Lifetime
Custom (e.g., a specific number of payouts or months)
Configure a maximum reward limit, this lets the merchant set a limit per user, per campaign. Please ensure it is higher than any per-payout limit.
Available reward options depend on the event types defined earlier.
4. Review and Finish Setup
Review Campaign Summary:
Name & Validity: Verify the campaign name and duration.
Events: Check that all listed events are correct.
Rewards: Confirm promoter and referred user reward details, including any total reward limit (e.g., “5% commission up to $10,” “1% commission,” “Total Reward Limit: $100”).
Finish Setup: If everything looks accurate, click “Finish Setup” to finalize your campaign.
Next Steps:
We will now understand how to setup a dashboard for the referees and referrers to view active campaigns and rewards.
Last updated