Skip to content
wanderer Documentation

update

POST
/list/{id}

Updates a list.

Authorizations

Parameters

Path Parameters

id
required
string
>= 15 characters <= 15 characters

List Id

Example
6vcudpc4wgc0ckk

Query Parameters

expand
string
requestKey
string

Unique request key. Prevents auto cancel when sending multiple requests.

Request Body

object
name

Name of the list

string
description

Description of the list

string
public

Visible for everyone

boolean
trails

List of trail Ids contained in the list

Array<string>
Example
{
  "name": "API List",
  "description": "A list created via the wanderer API",
  "public": true,
  "trails": [],
  "author": "3mugf953w4a9fg5"
}

Responses

200

object
author
required
string
avatar
required
string
collectionId
required
string
collectionName
required
string
created
required
string
description
required
string
id
required
string
name
required
string
public
required
boolean
trails
required
Array<string>
updated
required
string
Examples

Success

{
  "author": "3mugf953w4a9fg5",
  "avatar": "",
  "collectionId": "r6gu2ajyidy1x69",
  "collectionName": "lists",
  "created": "2025-01-02 22:29:19.092Z",
  "description": "This list was updated by the wanderer API",
  "id": "4yql7587j64qdo5",
  "name": "Updated API List",
  "public": false,
  "trails": [],
  "updated": "2025-01-02 22:39:36.944Z"
}

400

object
message
required
string
detail
required
Array<object>
object
code
string
minimum
integer
type
string
inclusive
boolean
exact
boolean
message
string
path
Array<string>
Examples

Exception

{
  "message": "invalid_params",
  "detail": [
    {
      "code": "too_small",
      "minimum": 15,
      "type": "string",
      "inclusive": true,
      "exact": true,
      "message": "String must contain exactly 15 character(s)",
      "path": [
        "id"
      ]
    }
  ]
}

404

object
message
required
string
detail
required
object
code
required
integer
message
required
string
data
required
object
Examples

Exception

{
  "message": "The requested resource wasn't found.",
  "detail": {
    "code": 404,
    "message": "The requested resource wasn't found.",
    "data": {}
  }
}