Create a new quest for projectId

POST 
/quest

Create a new quest for projectId

Request

application/json

Body

Quest data

questTypeId stringrequired

Unique identifier for the QuestType

descriptions string

Detailed descriptions of the different stages/applications of the quest

projectId projectId (string)required

Unique identifier for Project

userQuestsLimit integer

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

points integerrequired

Possible values: <= 1000000

The amount of points you gain after finishing the quest

name questName (string)required

Possible values: <= 64 characters

Name of the quest

refereeQuestId stringnullable

Unique identifier for the referee quest

state questState (string)

Possible values: [open, closed]

id questId (string)

Unique identifier for Quest

periodic questPeriodic (string)

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

data string

Quest-specific data in JSON format

prerequisites questId (string)[]nullable

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

Responses

201

Quest successfully created

application/json

Schema

Schema

questTypeId stringrequired

Unique identifier for the QuestType

descriptions string

Detailed descriptions of the different stages/applications of the quest

projectId projectId (string)required

Unique identifier for Project

userQuestsLimit integer

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

points integerrequired

Possible values: <= 1000000

The amount of points you gain after finishing the quest

thumbnail stringnullable

URL to the quest's thumbnail image

createdAt date-time

Time representation of entity creation

myUserQuestCount integer

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

name questName (string)required

Possible values: <= 64 characters

Name of the quest

refereeQuestId stringnullable

Unique identifier for the referee quest

state questState (string)

Possible values: [open, closed]

id questId (string)

Unique identifier for Quest

periodic questPeriodic (string)

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

userQuestCount integer

Number of times this quest has been completed.

data string

Quest-specific data in JSON format

referrerQuestId string

Unique identifier for the referrer quest

prerequisites questId (string)[]nullable

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

Example (from schema)

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