Create quest

Create quest in a community

POSThttps://api-v2.zealy.io/public/communities/{subdomain}/quests

Path parameters

subdomain*string

Header parameters

Body

application/json

Body

categoryId*string (uuid)

name*string

published*boolean

recurrence*enum

dailyweeklymonthlyonce

conditionOperator*enum

ANDOR

retryAfternullable one of

enumenumenumenumenumenumenumenum

description*nullable object

conditions*array of one of

rewards*array of all of

positionnumber

claimLimitnumber

sprintIdstring (uuid)

tasks*array of one of

Response

200400401403404409429500

200

Body

application/json

id*string (uuid)

name*string

recurrence*enum

dailyweeklymonthlyonce

description*nullable object

retryAfter*nullable number

archived*boolean

published*boolean

communityId*string (uuid)

categoryId*string (uuid)

conditionOperator*enum

ANDOR

conditions*array of one of

rewards*array of one of

tasks*array of all of

claimLimit*number

Request

JavaScriptCurlPython

const response = await fetch('https://api-v2.zealy.io/public/communities/{subdomain}/quests', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "categoryId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "published": false,
      "recurrence": "daily",
      "conditionOperator": "AND",
      "description": {
        "type": "text"
      },
      "conditions": [
        {
          "type": "quest",
          "operator": "isCompleted",
          "value": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "rewards": [
        {
          "type": "xp"
        }
      ],
      "tasks": [
        {
          "type": "partnership",
          "settings": {
            "subdomain": "text"
          }
        }
      ]
    }),
});
const data = await response.json();

Response

200400401403404409429500

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "recurrence": "daily",
  "description": {},
  "retryAfter": 0,
  "archived": false,
  "published": false,
  "communityId": "123e4567-e89b-12d3-a456-426614174000",
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "conditionOperator": "AND",
  "conditions": [
    {
      "type": "quest",
      "operator": "isCompleted",
      "value": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "rewards": [
    {
      "type": "xp"
    }
  ],
  "tasks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "partnership",
      "settings": {
        "subdomain": "text"
      }
    }
  ],
  "claimLimit": 0
}