Skip to main content
PUT
/
projects
/
{projectId}
/
quests
/
{questId}
Update a quest
curl --request PUT \
  --url https://api.engagefabric.com/projects/{projectId}/quests/{questId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "iconUrl": "<string>",
  "steps": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "count",
      "eventType": "<string>",
      "targetCount": 123,
      "description": "<string>",
      "filters": {},
      "timeWindowSeconds": 123
    }
  ],
  "prerequisites": [
    "<string>"
  ],
  "rewards": [
    {
      "type": "xp",
      "amount": 123,
      "currencyCode": "<string>",
      "badgeId": "<string>",
      "track": "<string>"
    }
  ],
  "repeatability": "ONCE",
  "cooldownSeconds": 123,
  "maxCompletions": 123,
  "availableFrom": "<string>",
  "availableUntil": "<string>",
  "timeLimitSeconds": 123,
  "category": "<string>",
  "tags": [
    "<string>"
  ],
  "sortOrder": 123,
  "metadata": {},
  "status": "DRAFT",
  "isActive": true
}
'

Path Parameters

projectId
string
required
questId
string
required

Body

application/json
name
string

Quest name

description
string

Quest description

iconUrl
string

Icon URL

steps
object[]

Quest steps

prerequisites
string[]

Quest IDs required before this quest

rewards
object[]

Rewards on completion

repeatability
enum<string>

How often quest can be repeated

Available options:
ONCE,
DAILY,
WEEKLY,
MONTHLY,
UNLIMITED
cooldownSeconds
number

Cooldown between completions in seconds

maxCompletions
number

Maximum number of completions

availableFrom
string

When quest becomes available

availableUntil
string

When quest availability ends

timeLimitSeconds
number

Time limit to complete in seconds

category
string

Quest category

tags
string[]

Quest tags

sortOrder
number

Display order

metadata
object

Custom metadata

status
enum<string>

Quest status

Available options:
DRAFT,
TESTING,
PUBLISHED,
ARCHIVED
isActive
boolean

Whether quest is active

Response

Quest updated successfully