Join a Game Master's virtual-tier group

POST

gm-add-to-group

curl --request POST \
  --url https://api.wanderersguide.app/functions/v1/gm-add-to-group \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "gm_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "access_code": "<string>"
}
'

{
  "status": "success",
  "data": "<string>"
}

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

gm_user_id

string<uuid>

required

access_code

string

required

Response

200 - application/json

JSend envelope.

Option 1
Option 2

status

enum<string>

Available options:

success

data

string

Remove a user from your GM groupCaller must be the GM. Removes the named user from the caller's virtual-tier group.

Join a Game Master's virtual-tier group

curl --request POST \
  --url https://api.wanderersguide.app/functions/v1/gm-add-to-group \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "gm_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "access_code": "<string>"
}
'

{
  "status": "success",
  "data": "<string>"
}