Skip to content

Upload an attachment

POST
/api/v1/attachments
curl --request POST \
--url https://example.com/api/v1/attachments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file=@file \
--form win_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0
Media typemultipart/form-data
object
file
required
string format: binary
win_id
string | null format: uuid

Attachment uploaded

Media typeapplication/json
object
byte_size
required
integer format: int64
content_type
required
string
created_at
required
string format: date-time
filename
required
string
id
required
string format: uuid
image
required
boolean
url
required
string format: uri-template
win_id
string | null format: uuid

Example generated

{
"byte_size": 1,
"content_type": "example",
"created_at": "2026-04-15T12:00:00Z",
"filename": "example",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"image": true,
"url": "example",
"win_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Authentication required

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

Plan storage limit reached

Media typeapplication/json
object
error
required
string
upgrade_url
required
string format: uri

Example generated

{
"error": "example",
"upgrade_url": "https://example.com"
}

Win not found

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

File too large

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

Unsupported file type

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

Validation failed

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}