Create a new quest for projectId

POST 
/quest

Create a new quest for projectId

Request

application/json

Body

Quest data

expiresAt date-timenullable

Expiration date for the quest

questTypeId stringrequired

Unique identifier for the QuestType

data string

Quest-specific data in JSON format

prerequisites questId (string)[]nullable

List of prerequisite quests that must be completed before starting this quest

userQuestsLimit integer

Maximum allowed number of times for the quest to be completed by a single user

refereeQuestId stringnullable

Unique identifier for the referee quest

descriptions string

Detailed descriptions of the different stages/applications of the quest

points integerrequired

Possible values: <= 1000000

The amount of points you gain after finishing the quest

periodic questPeriodic (string)

Possible values: [daily, weekly, monthly, hourly]

rankOrder integer

The order in which the quest should be displayed

state questState (string)

Possible values: [open, closed]

thumbnail stringnullable

URL to the quest's thumbnail image

projectId projectId (string)required

Unique identifier for Project

name questName (string)required

Possible values: <= 64 characters

Name of the quest

id questId (string)

Unique identifier for Quest

Responses

201

Quest successfully created

application/json

Schema

Schema

referrerQuestId string

Unique identifier for the referrer quest

expiresAt date-timenullable

Expiration date for the quest

questTypeId stringrequired

Unique identifier for the QuestType

data string

Quest-specific data in JSON format

prerequisites questId (string)[]nullable

List of prerequisite quests that must be completed before starting this quest

userQuestsLimit integer

Maximum allowed number of times for the quest to be completed by a single user

refereeQuestId stringnullable

Unique identifier for the referee quest

descriptions string

Detailed descriptions of the different stages/applications of the quest

points integerrequired

Possible values: <= 1000000

The amount of points you gain after finishing the quest

userQuestCount integer

Number of times this quest has been completed.

myUserQuestCount integer

Number of times this quest has been completed by the current user

maxStage integer

The index of the last stage (0 if not a StagesQuest)

periodic questPeriodic (string)

Possible values: [daily, weekly, monthly, hourly]

rankOrder integer

The order in which the quest should be displayed

createdAt date-time

Time representation of entity creation

state questState (string)

Possible values: [open, closed]

thumbnail stringnullable

URL to the quest's thumbnail image

projectId projectId (string)required

Unique identifier for Project

name questName (string)required

Possible values: <= 64 characters

Name of the quest

id questId (string)

Unique identifier for Quest

Example (from schema)

{
  "referrerQuestId": "Q3b19Z1n",
  "expiresAt": "2025-01-01T09:00:00.00Z",
  "questTypeId": "Q3b19Z1n",
  "data": "string",
  "prerequisites": [
    "q3b19Z1n"
  ],
  "userQuestsLimit": 3,
  "refereeQuestId": "Q3b19Z1n",
  "descriptions": "{\"short\":\"wishlist BF4 in order to obtain your points\",\"pre\":[\"stage 1 desc\",\"stage 2 desc\"]}",
  "points": 50,
  "userQuestCount": 1,
  "myUserQuestCount": 2,
  "maxStage": 5,
  "periodic": "daily",
  "rankOrder": 1,
  "createdAt": "2024-01-01T09:00:00.00Z",
  "state": "open",
  "thumbnail": "https://file.playmakers.co/p2Duhf5N6/aUv0OhmsR.jpg",
  "projectId": "p2Duhf5N6",
  "name": "Game referral",
  "id": "q3b19Z1n"
}

400

Bad Request

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Unauthorized access"
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...