Upload list file
POST
/api/v1/list/{id}/file
const url = 'https://example.com/api/v1/list/example/file';const form = new FormData();form.append('file', 'file');
const options = {method: 'POST'};
options.body = form;
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/list/example/file \ --header 'Content-Type: multipart/form-data' \ --form file=@fileUploads a file (cover image) for a list
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
Request Body required
Section titled “Request Body required ” Media type multipart/form-data
object
file
string format: binary
Responses
Section titled “ Responses ”File uploaded, list updated
Media type application/json
object
id
required
List ID (15 chars)
string
name
required
string
public
required
boolean
description
string
author
required
Author user ID
string
trails
Array<string>
created
string format: date-time
updated
string format: date-time
Example generated
{ "id": "example", "name": "example", "public": true, "description": "example", "author": "example", "trails": [ "example" ], "created": "2026-04-15T12:00:00Z", "updated": "2026-04-15T12:00:00Z"}Bad Request
Not Found
Internal Server Error