This endpoint allows you to add a new player to a campaign.
A player cannot be added if any of the following conditions are met:
- the campaign is ended or disabled
- the campaign doesn't use PLAYER_LIST strategy.
API Call Sample:
- stagehttps://asia.stage.rubyplay.io/api/v1/campaign/{campaignId}/participant
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://asia.stage.rubyplay.io/api/v1/campaign/123/participant \
-H 'Content-Type: application/json' \
-d '{
"playerId": "Player 777"
}'{ "id": 7, "playerId": "player123", "receivedAt": "2022-02-22T22:22:22Z", "totalBet": 777, "totalWin": 77, "roundsPlayed": 7, "lastRoundDate": "2022-02-22T22:22:22Z", "status": "QUEUED" }
Request Schema:
Player ID in Operatorʼs system.
Response Schema:
Player ID in RubyPlay system.
Player ID in Operatorʼs system.
Date and time of receiving free rounds.
Total bet amount of played free rounds.
Total win of free rounds.
The number of played free rounds.
Date and time of the last played free round.
QUEUED - A bonus is awarded to a player who has not used any of the free rounds yet.
IN_USE - A bonus is awarded to a player who has accepted the campaign. This status also applies to players who have started but haven't completed the free rounds yet. Free rounds for those players remain available even after the expiry date of the campaign.
COMPLETED - The player consumed all available free rounds, and any winnings have been awarded (issued to the Operator).
EXPIRED - The expiry date for free rounds has been reached, the promotion has been removed from player accounts, and any players who have not participated yet are not able to complete the promotion.