Bingo games

Endpoint to list all bingo games and associated tasks

GET/partner-api/v2/admin/bingo-games

Response

200

Successful response

Body

*/*

bingo_games*array of string

List of bingo games

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/v2/admin/bingo-games', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "bingo_games": [
    "text"
  ]
}

Create a bingo game.

POST/partner-api/v2/admin/bingo-games

Body

multipart/form-data

prize_ids*array of string

the prize_ids for the bingo game

name*string

the name of the Bingo game

descriptionstring

the name of the Bingo game

Response

201

Successful response

Body

*/*

bingo_game*object

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/v2/admin/bingo-games', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "prize_ids": [
        "text"
      ],
      "name": "text"
    }),
});
const data = await response.json();

Response

201

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

Get the bingo game with the given ID.

GET/partner-api/v2/admin/bingo-games/{bingo_game_id}

Path parameters

bingo_game_id*string

the ID of the Bingo game

Response

200

Successful response

Body

*/*

bingo_game*object

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/v2/admin/bingo-games/{bingo_game_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update a bingo game.

PATCH/partner-api/v2/admin/bingo-games/{bingo_game_id}

Path parameters

bingo_game_id*string

the ID of the Bingo game

Body

multipart/form-data

namestring

the name of the Bingo game

descriptionstring

the description of the Bingo game

prize_idsarray of string

the prize_ids for the bingo game

statusenum

the status of the Bingo game

draftpublishedarchived

Response

200

Successful response

Body

*/*

bingo_game*object

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/v2/admin/bingo-games/{bingo_game_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

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