Skip to main content
POST
/
create-encounter
Create or update an encounter
curl --request POST \
  --url https://api.wanderersguide.app/functions/v1/create-encounter \
  --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",
  "icon": "<string>",
  "color": "<string>",
  "campaign_id": 123,
  "combatants": {
    "list": [
      {}
    ]
  },
  "meta_data": {
    "description": "<string>",
    "party_level": 123,
    "party_size": 123
  }
}
'
{
  "status": "success",
  "data": {
    "name": "<string>",
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "icon": "<string>",
    "color": "<string>",
    "campaign_id": 123,
    "combatants": {
      "list": [
        {}
      ]
    },
    "meta_data": {
      "description": "<string>",
      "party_level": 123,
      "party_size": 123
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.wanderersguide.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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
name
string
required
id
integer
created_at
string<date-time>
user_id
string<uuid>
icon
string
color
string
campaign_id
integer
combatants
object
meta_data
object

Response

200 - application/json

JSend envelope.

status
enum<string>
Available options:
success
data