Upload New Attachment

POST

/collection/{collection_id}/attachment

Upload a file as a new Attachment and store it for this collection

The files are stored at our FS service.

TIP

With large files or files stored at a document management system like SharePoint, we highly recommend using Add New Attachment Link

WARNING

This endpoint does not support a base64 encoded upload.

For file upload we only support multipart/form-data.

TIP

Because oAuth is authenticated by a user, this is the user creating this attachment.
For integrations that are not user specific, customers are advised to create a separate user specifically for this integration.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

API Key

Add parameter in header

x-api-env

Example:

x-api-env: ********************

Path Params

Body Params multipart/form-data

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.vplan.com/v1/collection//attachment' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--form 'file=@""'

Responses

🟢201Created

application/json

Body

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "filename": "string",
    "file": "http://example.com",
    "type": "fs.mostwanted.io",
    "checksum": "string",
    "signature": "string",
    "bytes": 0,
    "thumbnail": "http://example.com",
    "thumbnail_type": "fs.mostwanted.io",
    "thumbnail_checksum": "string",
    "thumbnail_signature": "string",
    "thumbnail_bytes": 0,
    "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "external_ref": "fb1033a2ed70",
    "created_at": "2024-04-11T10:22:15Z",
    "updated_at": "2024-04-11T10:22:15Z"
}

🟠404Not Found

🟠401Not Logged In

Modified at 2025-07-24 09:37:44

Retrieve Attachment List

Add New Attachment Link