Puzzles

Endpoint to retrieve a puzzle

get

Authorizations

ApiKeyAuth

Path parameters

puzzle_idstringRequired

The ID of the puzzle to retrieve.

Responses

200

Successful response

application/json

get

HTTPcURLJavaScriptPython

GET /partner-api/v2/admin/puzzles/{puzzle_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "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"
    ]
  }
}

Endpoint to update a puzzle

patch

Authorizations

ApiKeyAuth

Path parameters

puzzle_idnumberRequired

Body

application/x-www-form-urlencoded

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

200

Successful response

application/json

patch

HTTPcURLJavaScriptPython

PATCH /partner-api/v2/admin/puzzles/{puzzle_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 116

"name='text'&description='text'&image_url='text'&reward_ids=[]&loot_box_ids=[]&earn_instructions='text'"

200

Successful response

{
  "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"
    ]
  }
}

Endpoint to create a puzzle

post

Authorizations

ApiKeyAuth

Body

application/x-www-form-urlencoded

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

200

Successful response

application/json

post

HTTPcURLJavaScriptPython

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

"image_url='text'&description='text'&name='text'&reward_ids=[]&loot_box_ids=[]&earn_instructions='text'"

200

Successful response

{
  "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"
    ]
  }
}