Skip to main content
POST
/
projects
/
{projectId}
/
adventures
Create a new adventure
curl --request POST \
  --url https://api.engagefabric.com/projects/{projectId}/adventures \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "startDate": "<string>",
  "endDate": "<string>",
  "description": "<string>",
  "bannerUrl": "<string>",
  "iconUrl": "<string>",
  "quests": [
    {
      "questId": "<string>",
      "sortOrder": 123,
      "unlockConditions": {
        "requiredQuestIds": [
          "<string>"
        ],
        "minAdventurePoints": 123,
        "minLevel": 123
      },
      "isRequired": true,
      "bonusRewards": [
        {
          "type": "xp",
          "amount": 123,
          "currencyCode": "<string>",
          "badgeId": "<string>",
          "track": "<string>"
        }
      ]
    }
  ],
  "rewards": [
    {
      "type": "xp",
      "amount": 123,
      "currencyCode": "<string>",
      "badgeId": "<string>",
      "track": "<string>"
    }
  ],
  "unlockConditions": {
    "requiredQuestIds": [
      "<string>"
    ],
    "minAdventurePoints": 123,
    "minLevel": 123
  },
  "sortOrder": 123,
  "metadata": {}
}
'

Path Parameters

projectId
string
required

Body

application/json
name
string
required

Adventure name

startDate
string
required

Start date (ISO 8601)

endDate
string
required

End date (ISO 8601)

description
string

Adventure description

bannerUrl
string

Banner image URL

iconUrl
string

Icon URL

quests
object[]

Quests in adventure

rewards
object[]

Rewards on completion

unlockConditions
object

Adventure unlock conditions

sortOrder
number

Display order

metadata
object

Custom metadata

Response

201

Adventure created successfully