Bingo games

Endpoint to list all bingo games and associated tasks

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Responses

200

Successful response

application/json

get

/v2/admin/bingo-games

HTTPcURLJavaScriptPython

GET /partner-api/v2/admin/bingo-games HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "bingo_games": [
    "text"
  ]
}

Create a bingo game.

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Body

application/x-www-form-urlencoded

prize_idsarrayRequired

the prize_ids for the bingo game

namestringRequired

the name of the Bingo game

descriptionstringOptional

the name of the Bingo game

Responses

201

Successful response

application/json

post

/v2/admin/bingo-games

HTTPcURLJavaScriptPython

POST /partner-api/v2/admin/bingo-games HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 51

"prize_ids=[]&name='text'&description='text'"

201

Successful response

{
  "bingo_game": {
    "id": "text",
    "name": "text",
    "description": "text",
    "status": "text",
    "prize_ids": [
      "text"
    ],
    "program_id": 1
  }
}

Get the bingo game with the given ID.

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

bingo_game_idstringRequired

the ID of the Bingo game

Responses

200

Successful response

application/json

get

/v2/admin/bingo-games/{bingo_game_id}

HTTPcURLJavaScriptPython

GET /partner-api/v2/admin/bingo-games/{bingo_game_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "bingo_game": {
    "id": "text",
    "name": "text",
    "description": "text",
    "status": "text",
    "prize_ids": [
      "text"
    ],
    "program_id": 1,
    "bingo_tasks": [
      "text"
    ]
  }
}

Update a bingo game.

patch

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

bingo_game_idstringRequired

the ID of the Bingo game

Body

application/x-www-form-urlencoded

namestringOptional

the name of the Bingo game

descriptionstringOptional

the description of the Bingo game

prize_idsarrayOptional

the prize_ids for the bingo game

statusstringOptional

the status of the Bingo game

Responses

200

Successful response

application/json

patch

/v2/admin/bingo-games/{bingo_game_id}

HTTPcURLJavaScriptPython

PATCH /partner-api/v2/admin/bingo-games/{bingo_game_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 67

"name='text'&description='text'&prize_ids=[]&status='text'"

200

Successful response

{
  "bingo_game": {
    "id": "text",
    "name": "text",
    "description": "text",
    "status": "text",
    "prize_ids": [
      "text"
    ],
    "program_id": 1
  }
}