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": [
{
"amount": 123,
"currencyCode": "<string>",
"badgeId": "<string>",
"track": "<string>"
}
]
}
],
"rewards": [
{
"amount": 123,
"currencyCode": "<string>",
"badgeId": "<string>",
"track": "<string>"
}
],
"unlockConditions": {
"requiredQuestIds": [
"<string>"
],
"minAdventurePoints": 123,
"minLevel": 123
},
"sortOrder": 123,
"metadata": {}
}
'import requests
url = "https://api.engagefabric.com/projects/{projectId}/adventures"
payload = {
"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": [
{
"amount": 123,
"currencyCode": "<string>",
"badgeId": "<string>",
"track": "<string>"
}
]
}
],
"rewards": [
{
"amount": 123,
"currencyCode": "<string>",
"badgeId": "<string>",
"track": "<string>"
}
],
"unlockConditions": {
"requiredQuestIds": ["<string>"],
"minAdventurePoints": 123,
"minLevel": 123
},
"sortOrder": 123,
"metadata": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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: [
{amount: 123, currencyCode: '<string>', badgeId: '<string>', track: '<string>'}
]
}
],
rewards: [
{amount: 123, currencyCode: '<string>', badgeId: '<string>', track: '<string>'}
],
unlockConditions: {requiredQuestIds: ['<string>'], minAdventurePoints: 123, minLevel: 123},
sortOrder: 123,
metadata: {}
})
};
fetch('https://api.engagefabric.com/projects/{projectId}/adventures', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.engagefabric.com/projects/{projectId}/adventures",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => [
[
'amount' => 123,
'currencyCode' => '<string>',
'badgeId' => '<string>',
'track' => '<string>'
]
]
]
],
'rewards' => [
[
'amount' => 123,
'currencyCode' => '<string>',
'badgeId' => '<string>',
'track' => '<string>'
]
],
'unlockConditions' => [
'requiredQuestIds' => [
'<string>'
],
'minAdventurePoints' => 123,
'minLevel' => 123
],
'sortOrder' => 123,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.engagefabric.com/projects/{projectId}/adventures"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"description\": \"<string>\",\n \"bannerUrl\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"quests\": [\n {\n \"questId\": \"<string>\",\n \"sortOrder\": 123,\n \"unlockConditions\": {\n \"requiredQuestIds\": [\n \"<string>\"\n ],\n \"minAdventurePoints\": 123,\n \"minLevel\": 123\n },\n \"isRequired\": true,\n \"bonusRewards\": [\n {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"badgeId\": \"<string>\",\n \"track\": \"<string>\"\n }\n ]\n }\n ],\n \"rewards\": [\n {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"badgeId\": \"<string>\",\n \"track\": \"<string>\"\n }\n ],\n \"unlockConditions\": {\n \"requiredQuestIds\": [\n \"<string>\"\n ],\n \"minAdventurePoints\": 123,\n \"minLevel\": 123\n },\n \"sortOrder\": 123,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.engagefabric.com/projects/{projectId}/adventures")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"description\": \"<string>\",\n \"bannerUrl\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"quests\": [\n {\n \"questId\": \"<string>\",\n \"sortOrder\": 123,\n \"unlockConditions\": {\n \"requiredQuestIds\": [\n \"<string>\"\n ],\n \"minAdventurePoints\": 123,\n \"minLevel\": 123\n },\n \"isRequired\": true,\n \"bonusRewards\": [\n {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"badgeId\": \"<string>\",\n \"track\": \"<string>\"\n }\n ]\n }\n ],\n \"rewards\": [\n {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"badgeId\": \"<string>\",\n \"track\": \"<string>\"\n }\n ],\n \"unlockConditions\": {\n \"requiredQuestIds\": [\n \"<string>\"\n ],\n \"minAdventurePoints\": 123,\n \"minLevel\": 123\n },\n \"sortOrder\": 123,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engagefabric.com/projects/{projectId}/adventures")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"description\": \"<string>\",\n \"bannerUrl\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"quests\": [\n {\n \"questId\": \"<string>\",\n \"sortOrder\": 123,\n \"unlockConditions\": {\n \"requiredQuestIds\": [\n \"<string>\"\n ],\n \"minAdventurePoints\": 123,\n \"minLevel\": 123\n },\n \"isRequired\": true,\n \"bonusRewards\": [\n {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"badgeId\": \"<string>\",\n \"track\": \"<string>\"\n }\n ]\n }\n ],\n \"rewards\": [\n {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"badgeId\": \"<string>\",\n \"track\": \"<string>\"\n }\n ],\n \"unlockConditions\": {\n \"requiredQuestIds\": [\n \"<string>\"\n ],\n \"minAdventurePoints\": 123,\n \"minLevel\": 123\n },\n \"sortOrder\": 123,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_bodyAdventures
Create a new adventure
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": [
{
"amount": 123,
"currencyCode": "<string>",
"badgeId": "<string>",
"track": "<string>"
}
]
}
],
"rewards": [
{
"amount": 123,
"currencyCode": "<string>",
"badgeId": "<string>",
"track": "<string>"
}
],
"unlockConditions": {
"requiredQuestIds": [
"<string>"
],
"minAdventurePoints": 123,
"minLevel": 123
},
"sortOrder": 123,
"metadata": {}
}
'import requests
url = "https://api.engagefabric.com/projects/{projectId}/adventures"
payload = {
"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": [
{
"amount": 123,
"currencyCode": "<string>",
"badgeId": "<string>",
"track": "<string>"
}
]
}
],
"rewards": [
{
"amount": 123,
"currencyCode": "<string>",
"badgeId": "<string>",
"track": "<string>"
}
],
"unlockConditions": {
"requiredQuestIds": ["<string>"],
"minAdventurePoints": 123,
"minLevel": 123
},
"sortOrder": 123,
"metadata": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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: [
{amount: 123, currencyCode: '<string>', badgeId: '<string>', track: '<string>'}
]
}
],
rewards: [
{amount: 123, currencyCode: '<string>', badgeId: '<string>', track: '<string>'}
],
unlockConditions: {requiredQuestIds: ['<string>'], minAdventurePoints: 123, minLevel: 123},
sortOrder: 123,
metadata: {}
})
};
fetch('https://api.engagefabric.com/projects/{projectId}/adventures', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.engagefabric.com/projects/{projectId}/adventures",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => [
[
'amount' => 123,
'currencyCode' => '<string>',
'badgeId' => '<string>',
'track' => '<string>'
]
]
]
],
'rewards' => [
[
'amount' => 123,
'currencyCode' => '<string>',
'badgeId' => '<string>',
'track' => '<string>'
]
],
'unlockConditions' => [
'requiredQuestIds' => [
'<string>'
],
'minAdventurePoints' => 123,
'minLevel' => 123
],
'sortOrder' => 123,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.engagefabric.com/projects/{projectId}/adventures"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"description\": \"<string>\",\n \"bannerUrl\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"quests\": [\n {\n \"questId\": \"<string>\",\n \"sortOrder\": 123,\n \"unlockConditions\": {\n \"requiredQuestIds\": [\n \"<string>\"\n ],\n \"minAdventurePoints\": 123,\n \"minLevel\": 123\n },\n \"isRequired\": true,\n \"bonusRewards\": [\n {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"badgeId\": \"<string>\",\n \"track\": \"<string>\"\n }\n ]\n }\n ],\n \"rewards\": [\n {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"badgeId\": \"<string>\",\n \"track\": \"<string>\"\n }\n ],\n \"unlockConditions\": {\n \"requiredQuestIds\": [\n \"<string>\"\n ],\n \"minAdventurePoints\": 123,\n \"minLevel\": 123\n },\n \"sortOrder\": 123,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.engagefabric.com/projects/{projectId}/adventures")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"description\": \"<string>\",\n \"bannerUrl\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"quests\": [\n {\n \"questId\": \"<string>\",\n \"sortOrder\": 123,\n \"unlockConditions\": {\n \"requiredQuestIds\": [\n \"<string>\"\n ],\n \"minAdventurePoints\": 123,\n \"minLevel\": 123\n },\n \"isRequired\": true,\n \"bonusRewards\": [\n {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"badgeId\": \"<string>\",\n \"track\": \"<string>\"\n }\n ]\n }\n ],\n \"rewards\": [\n {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"badgeId\": \"<string>\",\n \"track\": \"<string>\"\n }\n ],\n \"unlockConditions\": {\n \"requiredQuestIds\": [\n \"<string>\"\n ],\n \"minAdventurePoints\": 123,\n \"minLevel\": 123\n },\n \"sortOrder\": 123,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engagefabric.com/projects/{projectId}/adventures")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"description\": \"<string>\",\n \"bannerUrl\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"quests\": [\n {\n \"questId\": \"<string>\",\n \"sortOrder\": 123,\n \"unlockConditions\": {\n \"requiredQuestIds\": [\n \"<string>\"\n ],\n \"minAdventurePoints\": 123,\n \"minLevel\": 123\n },\n \"isRequired\": true,\n \"bonusRewards\": [\n {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"badgeId\": \"<string>\",\n \"track\": \"<string>\"\n }\n ]\n }\n ],\n \"rewards\": [\n {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"badgeId\": \"<string>\",\n \"track\": \"<string>\"\n }\n ],\n \"unlockConditions\": {\n \"requiredQuestIds\": [\n \"<string>\"\n ],\n \"minAdventurePoints\": 123,\n \"minLevel\": 123\n },\n \"sortOrder\": 123,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_bodyPath Parameters
Body
application/json
Adventure name
Start date (ISO 8601)
End date (ISO 8601)
Adventure description
Banner image URL
Icon URL
Quests in adventure
Show child attributes
Show child attributes
Rewards on completion
Show child attributes
Show child attributes
Adventure unlock conditions
Show child attributes
Show child attributes
Display order
Custom metadata
Response
201
Adventure created successfully
⌘I
