Puzzles

Endpoint to retrieve a puzzle

get

Authorizations

Path parameters

puzzle_idanyrequired

The ID of the puzzle to retrieve.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v2/admin/puzzles/{puzzle_id}' \
  --header 'X-API-Key: YOUR_API_KEY'

200

200

{
  "puzzle": {
    "id": "text",
    "program_id": 1,
    "name": "text",
    "description": "text",
    "earn_instructions": "text",
    "image_url": "text",
    "status": "text",
    "archived_at": 1,
    "published_at": 1,
    "rewards": [
      "text"
    ]
  }
}

Successful response

Endpoint to update a puzzle

patch

Authorizations

Path parameters

puzzle_idanyrequired

Body

namestringoptional

Name/title of the Puzzle object.

descriptionstringoptional

Description of the Puzzle object.

image_urlstringoptional

URL of the image file.

reward_idsarrayoptional

Array of reward IDs that are associated with the puzzle. Example [1] or [1,2,3].

loot_box_idsarrayoptional

Array of loot box IDs that are associated with the puzzle. Example ['ca338290-0a9b-447e-bef7-943f81a90a28'] or ['ca338290-0a9b-447e-bef7-943f81a90a28','a25a2468-180c-4e7d-953c-99fff4f9484f'].

earn_instructionsstringoptional

Instructions for earning the puzzle.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/v2/admin/puzzles/{puzzle_id}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'name=text&description=text&image_url=text&reward_ids=&loot_box_ids=&earn_instructions=text'

200

200

{
  "puzzle": {
    "id": "text",
    "program_id": 1,
    "name": "text",
    "description": "text",
    "earn_instructions": "text",
    "image_url": "text",
    "status": "text",
    "archived_at": 1,
    "published_at": 1,
    "rewards": [
      "text"
    ]
  }
}

Successful response

Endpoint to create a puzzle

post

Authorizations

Body

image_urlstringrequired

URL of the image file.

descriptionstringrequired

Description of the Puzzle object.

namestringrequired

Name/title of the Puzzle object.

reward_idsarrayoptional

Array of reward IDs that are associated with the puzzle. Example [1] or [1,2,3].

loot_box_idsarrayoptional

Array of loot box IDs that are associated with the puzzle. Example ['ca338290-0a9b-447e-bef7-943f81a90a28'] or ['ca338290-0a9b-447e-bef7-943f81a90a28','a25a2468-180c-4e7d-953c-99fff4f9484f'].

earn_instructionsstringoptional

Instructions for earning the puzzle.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/admin/puzzles' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'image_url=text&description=text&name=text&reward_ids=&loot_box_ids=&earn_instructions=text'

200

200

{
  "puzzle": {
    "id": "text",
    "program_id": 1,
    "name": "text",
    "description": "text",
    "earn_instructions": "text",
    "image_url": "text",
    "status": "text",
    "archived_at": 1,
    "published_at": 1,
    "rewards": [
      "text"
    ]
  }
}

Successful response