Sign in

v1

latestOpenAPI 3.0.32026-07-1481519.8 KB
Free Rounds

Create Free Rounds

Create new free rounds campaign

post/free-rounds

Headers

X-REQUEST-SIGNstring required

Request signature (read more in the Authentication section)

Request body

external_idstring required

Free rounds ID (external). Used as idempotency key. Same ID can be used to create free rounds only once.

cidstring uuid required

Client's ID (internal)

external_cidstring required

External Client's ID (game aggregator or casino)

game_idstring required

Game's ID

provider_idstring required

Provider ID. If you're using Playhub Integration Adapter pass playhub here.

user_idsstring[]

List of player IDs (external). if null then campaign is available for all players.

currencystring required

Currency code in ISO4217

quantityinteger required

Number of free rounds.

bet_lineinteger required

Number of bet line configured for this game/provider.

valid_fromstring date-time required

Start date when free rounds become available. ISO 8601. This should be in future. It's not possible to create Free Rounds campaign in the past. If you want to create a campaign "from now", just add a few seconds to the current time. Creation process is synchronous, so make sure that under heavy load our server could process this request for a few seconds.

valid_untilstring date-time

End date when free rounds become unavailable. Could be setup later. ISO 8601.

Example request

{
  "valid_from": "2021-01-01T00:00:00Z",
  "valid_until": "2021-01-01T00:00:00Z"
}

Response

ok

idstring uuid required

Free rounds ID (internal)

external_idstring required

Free rounds ID (external). This is provided in the request.