Skip to content

file

POST
/list/{id}/file

Uploads an avatar file for a list.

Authorizations

Parameters

Path Parameters

id
required
string

List Id

Example
4yql7587j64qdo5

Request Body

object
avatar
required

Avatar image file. Allowed file types: PNG, JPG, WEBP, SVG

string format: binary
file:///Users/christianbeutel/Downloads/23xxesym0e9w18z2904frnpgy7.jpg

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": "23xxesym0e9w18z2904frnpgy7_bmAvN4NpoA.jpg",
"collectionId": "r6gu2ajyidy1x69",
"collectionName": "lists",
"created": "2024-12-13 12:46:49.620Z",
"description": "",
"id": "m59tuo2yyretv7z",
"name": "Flomp's List 2",
"public": false,
"trails": [
"ovo0m6pxxjupfp9"
],
"updated": "2025-01-02 23:06:30.788Z"
}

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": {}
}
}