This Provider API Endpoint allows an Operator to remove Free Bets from user accounts. By providing player identifiers and the respective promotion details, developers can effortlessly void promotions, with a clear response indicating the success or failure of the removal process. This structure aids in maintaining an effective promotional strategy, allowing you to remove promotional Free Bets previously granted to players. This API removes Players' Free Bets under one promotion only, similarly to how Free Bets were initially issued under one promotion.
/free-bets/remove
Free Bets APIs are disabled by default. To enable this feature, please contact your account manager.
Operator calls this endpoint on the Provider to remove promotional Free Bets from specified players in a safe, auditable, and idempotent way.
Multiple players' Free Bets can be removed with this request:
playerIds is omitted or empty, all players under the specified promotion (promotionId) will have their Free Bets removed.playerIds. Players must have been granted Free Bets previously under this promotionId.If promotion's Free Bets were removed before, or all players under this promotion have consumed all their Free Bets, this API will still return OK.
Refer to Free Bets section to understand how Free Bets work.
Refer to Add Free Bets section to understand how Free Bets are added.
Refer to Free Bets Stats section to understand how Free Bets statistics are checked.
Request Headers
| Key | Value Type | Required | Description |
|---|---|---|---|
authorization |
string | Yes | API Authorization token |
Content-Type |
string | Yes | Strictly application/json |
Request Body
| Key | Value Type | Required | Description |
|---|---|---|---|
promotionId |
string | Yes | UUIDv4 unique identifier for the promotion associated with the Free Bets to remove. |
playerIds |
Array<string> |
No | List of Player Identifiers for players whose Free Bets will be removed. String Must not contain / character. Maximum of 100 items is accepted. |
uniqueId |
string | Yes | Operator-generated UUIDv4. Returned in the API response. |
Response Body
| Key | Value Type | Required | Description |
|---|---|---|---|
status |
string | Yes | See RemoveFreeBetsResponseStatus. |
statusCode |
number | Yes | See ProviderResponseStatusCode reference. |
statusMessage |
string | No | Verbose human-friendly description of the status. |
success |
boolean | Yes | Indicates if the request was successfully processed. |
uniqueId |
string | Yes | Operator-generated UUIDv4. Same value from API request. |
RemoveFreeBetsResponseStatus
| Status Code | Status | Description |
|---|---|---|
| 0 | OK |
Free Bets were removed successfully. |
| 50 | INTERNAL_ERROR |
Some internal error happened within the Provider when trying to remove the Free Bets. |
| 56 | OPERATOR_IS_NOT_ENABLED |
Operator is not enabled. Please contact support. |
| 70 | OPERATOR_FEATURE_DISABLED |
Operator feature is disabled. Please contact support. |
| 71 | PROMOTION_NOT_FOUND |
Promotion not found for requested promotionId. |
curl -X POST "https://< Provider API Base Path - Contact Technical Support >/free-bets/remove" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "authorization: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" \
--data '{
"promotionId": "sample-promotion-id-100",
"playerIds": [
"sample-player-id-10",
"sample-player-id-20"
],
"uniqueId": "5E2AD325-1C57-41BA-AD23-D6D34B32A63A"
}'
Request Body
{
"promotionId": "sample-promotion-id-100",
"playerIds": ["sample-player-id-10", "sample-player-id-20"],
"uniqueId": "5E2AD325-1C57-41BA-AD23-D6D34B32A63A"
}
OK
{
"status": "OK",
"statusCode": 0,
"success": true,
"uniqueId": "5E2AD325-1C57-41BA-AD23-D6D34B32A63A"
}
INTERNAL_ERROR
{
"status": "INTERNAL_ERROR",
"statusCode": 50,
"success": false,
"uniqueId": "5E2AD325-1C57-41BA-AD23-D6D34B32A63A"
}
OPERATOR_IS_NOT_ENABLED
{
"status": "OPERATOR_IS_NOT_ENABLED",
"statusCode": 56,
"success": false,
"uniqueId": "5E2AD325-1C57-41BA-AD23-D6D34B32A63A"
}
OPERATOR_FEATURE_DISABLED
{
"status": "OPERATOR_FEATURE_DISABLED",
"statusCode": 70,
"success": false,
"uniqueId": "5E2AD325-1C57-41BA-AD23-D6D34B32A63A"
}
PROMOTION_NOT_FOUND
{
"status": "PROMOTION_NOT_FOUND",
"statusCode": 71,
"success": false,
"uniqueId": "5E2AD325-1C57-41BA-AD23-D6D34B32A63A"
}