Marketing Campaigns
On the Marketing Campaigns page, you can set up rewards for activities for certain user groups.
The Marketing Campaigns feature supports the following types of rewards:
Registration reward: the user receives a specified amount of tokens after registration.
KYC reward: the user receives a specified amount of tokens when verification is completed.
Cashback reward: the user receives a share from their own GGR.
Deposit reward: give rewards to users when they achieve the desired deposit volume.
Token purchase: allow the user to purchase the desired amount of tokens.
Custom.
The following restrictions may be applied to reward distribution:
campaign date
campaign duration
the number of users that can participate
a user segment that can be defined by an API
Marketing Campaigns life cycle
Campaign status:
Draft: The status is assigned immediately after a campaign is created.
Active: This status is assigned to the campaign list. When a campaign is active, users can be added and start receiving rewards.
Deactivated: This status is assigned to the campaign list. When a campaign is deactivated, users cannot be added.
Expired: The status is assigned to a campaign automatically when reward distribution reaches the limit (upon reaching the expiration date or the maximum number of users in the campaign).
Deleted: The status is assigned when a campaign is permanently removed from the system.
Creating a campaign
To create a campaign, click on the Create Campaign (Fig. 2) button and configure campaign settings.
To create a campaign, enter its name and configure the reward. The campaign will be added to the list and assigned a Draft status. When the campaign has Active status, users will be added to the campaign (according to automatic rules or using API).
To create a campaign, enter its name and configure the reward. The campaign will be added to the list and assigned a Draft status. When the campaign has Active status, users will be added to the campaign (according to automatic rules or using API).
Campaign management
Created campaigns can be filtered by status and date.
On the Marketing Campaigns page, you can perform the following actions with the campaign (Fig. 4):
Change status
Add users to the campaign
Check the list of users added to the campaign
View campaign configuration
Edit the created campaign (if assigned Draft, Deactivated, Expired status)
Delete the campaign (if assigned Draft, Deactivated, Expired status)
API
The Marketing Campaigns API supports the following methods:
Get all Active Marketing Campaigns. This returns a list of active Marketing Campaigns. It must be run before adding a user to the campaign to avoid accidentally adding a user to a campaign with a Draft/Expired/Deactivated status.
Get Marketing Campaigns participants by ID. Returns a list of Marketing Campaigns participants.
Assign User to Marketing Campaigns. Adding a user to the campaign.
Delete User from Marketing Campaigns. Deleting a user from the campaign.
Get all Active Marketing Campaigns
METHOD | GET |
URL | https://integration.trueplay.io/api/v1/promo-campaign/active |
HEADER | X-API-KEY (see value at Integration Settings) |
PARAMETERS | - |
RESPONSE | [ { "betVolumeRule": 0, "createdAt": "2023-04-20T09:13:51.735Z", "dailyCashbackReward": 0, "duration": 0, "expirationDate": "2023-04-20", "fixedAmountReward": 500, "id": 0, "kycRule": true, "maxUserCount": 0, "name": "Campaing_1", "p2eMultiplierReward": 1.5, "signUpRule": true, "stakingLimitCoefficientReward": 10000, "status": "Active" }, { "betVolumeRule": 0, "createdAt": "2023-04-20T09:13:51.735Z", "dailyCashbackReward": 0, "duration": 0, "expirationDate": "2023-04-20", "fixedAmountReward": 50, "id": 0, "kycRule": false, "maxUserCount": 0, "name": "string", "p2eMultiplierReward": 0, "signUpRule": true, "stakingLimitCoefficientReward": 15000, "status": "Active" } ] |
STATUS CODES | 200 OK - The request is successful 400 Bad Request - Invalid request parameters provided 401 Unauthorized - Requester is unauthorized to perform an action 403 Forbidden - Requester is forbidden to perform an action 404 Not Found - Resource not found |
Get Marketing Campaigns participants by campaign ID
METHOD | GET |
URL | https://integration.trueplay.io/api/v1/promo-campaign/{campaign_id}/participants |
HEADER | X-API-KEY (see value at Integration Settings) |
PARAMETERS | - id - Operator ID |
RESPONSE | { "content": [ { "campingId": 10, "createdAt": "2023-04-20T09:15:40.545Z", "method": "API", "operatorUserId": "23423", }, { "campingId": 15, "createdAt": "2023-04-20T09:15:40.545Z", "method": "Manual", "operatorUserId": "97500", }, ] |
STATUS CODES | 200 OK - The request is successful 400 Bad Request - Invalid request parameters provided 401 Unauthorized - Requester is unauthorized to perform an action 403 Forbidden - Requester is forbidden to perform an action 404 Not Found - Resource not found |
Assign User to the Marketing Campaigns
METHOD | POST |
URL | https://integration.trueplay.io/api/v1/promo-campaign/{campaignId}/user/{operatorUserId} |
HEADER | X-API-KEY (see value at Integration Settings) |
PARAMETERS | - Campaign ID - Operator user ID |
RESPONSE | { "campingId": 0, "createdAt": "2023-04-20T09:17:49.302Z", "method": "API", "operatorUserId": "65464", "transaction": "API" } |
STATUS CODES | 200 OK - The request is successful 400 Bad Request - Invalid request parameters provided 401 Unauthorized - Requester is unauthorized to perform an action 403 Forbidden - Requester is forbidden to perform an action 404 Not Found - Resource not found |
Delete User from the Marketing Campaigns
METHOD | DELETE |
URL | https://integration.trueplay.io/api/v1/promo-campaign/{campaignId}/user/{operatorUserId} |
HEADER | X-API-KEY (see value at Integration Settings) |
PARAMETERS | - Campaign ID - Operator user ID |
STATUS CODES | 200 OK - The request is successful 400 Bad Request - Invalid request parameters provided 401 Unauthorized - Requester is unauthorized to perform an action 403 Forbidden - Requester is forbidden to perform an action 404 Not Found - Resource not found |
Last updated
