Create free spin event

Creates an event. Members who join it receive free spin rewards. A new event is inactive by default.
Four join modes are available: All (all members of the platform), Add (a list of member accounts), API (by event ID) and Channel (channels of the platform):
a. channelIDList only applies when joinOption is cha.
b. memberList only applies when joinOption is add.
An event can be bound to multiple games.
A member can join an event only once, until the event is full. When the member enters the game, the join mode decides whether the member receives the reward.
Free spins use a fixed bet amount. Because bet options differ between games, the system picks the closest available bet; 0 picks the lowest bet.
A player’s total free spin winnings must be at least the minimum withdrawal amount to be paid out.
If a player’s total free spin winnings exceed the maximum withdrawal amount, the player receives only the maximum withdrawal amount.

Path

POST {host}/api/v1.0/event/create

Headers

Field	Type	Required	Description
`Authorization`	string	Yes	Token we provide
`Content-Type`	string	Yes	`multipart/form-data`

Request parameters

Field	Type	Required	Signed	Description
`eventID`	string	Yes	✓	Event ID (allowed characters: `a-z A-Z 0-9 _`)
`startTime`	string	Yes	✓	Start time (ISO 8601 without time zone: yyyy-MM-ddTHH:mm:ss)
`endTime`	string	Yes	✓	End time (ISO 8601 without time zone: yyyy-MM-ddTHH:mm:ss)
`zoneID`	string	Yes	✓	Time zone used to display event times to players (GMT-12 to GMT+12)
`eventName`	string	Yes	✓	Event name
`currency`	string	Yes	✓	Currency
`gameIDList`	string	Yes	✓	Game IDs that can be used (comma-separated)
`bet`	number	Yes	✓	Bet (up to 2 decimal places)
`freeSpinTimes`	number	Yes	✓	Number of free spins
`maxMemberCount`	number	Yes	✓	Maximum number of players
`minWithdraw`	number	Yes	✓	Minimum withdrawal amount (up to 2 decimal places)
`maxWithdraw`	number	Yes	✓	Maximum withdrawal amount (up to 2 decimal places)
`joinOption`	string	Yes	✓	Join type (api, add, all, cha)
`channelIDList`	string	No	✓	Channel IDs (comma-separated)
`memberList`	string	No	✓	Accounts to bind (comma-separated)
`note`	string	No	✓	Note
`sign`	string	Yes		Signature. See Signature for how to generate it

Response

Success (the HTTP status code is always 200; check status.code for the result)

Field	Type	Description
`data`	object
`data.eventID`	string	Event ID
`status`	object	Response status. See Response format

Response example

{
  "data": {
    "eventID": "a_testevent_123"
  },
  "status": {
    "code": "0",
    "message": "success",
    "datetime": "2022-07-01T10:13:54.920+08:00",
    "traceCode": "7cf25e1957cc47fe8e01f1a7c6d504d6"
  }
}

Getting started

API documentation

Appendix

Create free spin event

Path

Headers

Request parameters

Response

Response example