Campaigns & encounters
Create or update a campaign
Creating a new campaign requires Patreon tier 1+ (free users cannot create campaigns).
POST
/
create-campaign
Create or update a campaign
curl --request POST \
--url https://api.wanderersguide.app/functions/v1/create-campaign \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": {
"contents": {}
},
"join_key": "<string>",
"notes": {},
"recommended_options": {},
"recommended_variants": {},
"recommended_content_sources": {
"enabled": [
123
]
},
"custom_operations": [
{}
],
"meta_data": {}
}
'import requests
url = "https://api.wanderersguide.app/functions/v1/create-campaign"
payload = {
"name": "<string>",
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": { "contents": {} },
"join_key": "<string>",
"notes": {},
"recommended_options": {},
"recommended_variants": {},
"recommended_content_sources": { "enabled": [123] },
"custom_operations": [{}],
"meta_data": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
id: 123,
created_at: '2023-11-07T05:31:56Z',
user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: {contents: {}},
join_key: '<string>',
notes: {},
recommended_options: {},
recommended_variants: {},
recommended_content_sources: {enabled: [123]},
custom_operations: [{}],
meta_data: {}
})
};
fetch('https://api.wanderersguide.app/functions/v1/create-campaign', 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.wanderersguide.app/functions/v1/create-campaign",
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>',
'id' => 123,
'created_at' => '2023-11-07T05:31:56Z',
'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => [
'contents' => [
]
],
'join_key' => '<string>',
'notes' => [
],
'recommended_options' => [
],
'recommended_variants' => [
],
'recommended_content_sources' => [
'enabled' => [
123
]
],
'custom_operations' => [
[
]
],
'meta_data' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.wanderersguide.app/functions/v1/create-campaign"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"id\": 123,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": {\n \"contents\": {}\n },\n \"join_key\": \"<string>\",\n \"notes\": {},\n \"recommended_options\": {},\n \"recommended_variants\": {},\n \"recommended_content_sources\": {\n \"enabled\": [\n 123\n ]\n },\n \"custom_operations\": [\n {}\n ],\n \"meta_data\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.wanderersguide.app/functions/v1/create-campaign")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"id\": 123,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": {\n \"contents\": {}\n },\n \"join_key\": \"<string>\",\n \"notes\": {},\n \"recommended_options\": {},\n \"recommended_variants\": {},\n \"recommended_content_sources\": {\n \"enabled\": [\n 123\n ]\n },\n \"custom_operations\": [\n {}\n ],\n \"meta_data\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wanderersguide.app/functions/v1/create-campaign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"id\": 123,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": {\n \"contents\": {}\n },\n \"join_key\": \"<string>\",\n \"notes\": {},\n \"recommended_options\": {},\n \"recommended_variants\": {},\n \"recommended_content_sources\": {\n \"enabled\": [\n 123\n ]\n },\n \"custom_operations\": [\n {}\n ],\n \"meta_data\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"name": "<string>",
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": {
"contents": {}
},
"join_key": "<string>",
"notes": {},
"recommended_options": {},
"recommended_variants": {},
"recommended_content_sources": {
"enabled": [
123
]
},
"custom_operations": [
{}
],
"meta_data": {}
}
}Authorizations
API key created in your Wanderer's Guide account settings. Send as Authorization: Bearer <key>. Used for direct API access from external tools and scripts.
Body
application/json
⌘I
Create or update a campaign
curl --request POST \
--url https://api.wanderersguide.app/functions/v1/create-campaign \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": {
"contents": {}
},
"join_key": "<string>",
"notes": {},
"recommended_options": {},
"recommended_variants": {},
"recommended_content_sources": {
"enabled": [
123
]
},
"custom_operations": [
{}
],
"meta_data": {}
}
'import requests
url = "https://api.wanderersguide.app/functions/v1/create-campaign"
payload = {
"name": "<string>",
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": { "contents": {} },
"join_key": "<string>",
"notes": {},
"recommended_options": {},
"recommended_variants": {},
"recommended_content_sources": { "enabled": [123] },
"custom_operations": [{}],
"meta_data": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
id: 123,
created_at: '2023-11-07T05:31:56Z',
user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: {contents: {}},
join_key: '<string>',
notes: {},
recommended_options: {},
recommended_variants: {},
recommended_content_sources: {enabled: [123]},
custom_operations: [{}],
meta_data: {}
})
};
fetch('https://api.wanderersguide.app/functions/v1/create-campaign', 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.wanderersguide.app/functions/v1/create-campaign",
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>',
'id' => 123,
'created_at' => '2023-11-07T05:31:56Z',
'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => [
'contents' => [
]
],
'join_key' => '<string>',
'notes' => [
],
'recommended_options' => [
],
'recommended_variants' => [
],
'recommended_content_sources' => [
'enabled' => [
123
]
],
'custom_operations' => [
[
]
],
'meta_data' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.wanderersguide.app/functions/v1/create-campaign"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"id\": 123,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": {\n \"contents\": {}\n },\n \"join_key\": \"<string>\",\n \"notes\": {},\n \"recommended_options\": {},\n \"recommended_variants\": {},\n \"recommended_content_sources\": {\n \"enabled\": [\n 123\n ]\n },\n \"custom_operations\": [\n {}\n ],\n \"meta_data\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.wanderersguide.app/functions/v1/create-campaign")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"id\": 123,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": {\n \"contents\": {}\n },\n \"join_key\": \"<string>\",\n \"notes\": {},\n \"recommended_options\": {},\n \"recommended_variants\": {},\n \"recommended_content_sources\": {\n \"enabled\": [\n 123\n ]\n },\n \"custom_operations\": [\n {}\n ],\n \"meta_data\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wanderersguide.app/functions/v1/create-campaign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"id\": 123,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": {\n \"contents\": {}\n },\n \"join_key\": \"<string>\",\n \"notes\": {},\n \"recommended_options\": {},\n \"recommended_variants\": {},\n \"recommended_content_sources\": {\n \"enabled\": [\n 123\n ]\n },\n \"custom_operations\": [\n {}\n ],\n \"meta_data\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"name": "<string>",
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": {
"contents": {}
},
"join_key": "<string>",
"notes": {},
"recommended_options": {},
"recommended_variants": {},
"recommended_content_sources": {
"enabled": [
123
]
},
"custom_operations": [
{}
],
"meta_data": {}
}
}
