Add New Attachment Link

POST

/collection/{collection_id}/attachment

Add a link as new Attachment and store it for this collection

Possible usages are:

large files (e.g. cad files)

better version control, e.g. prevent having old versions in vPlan

enhanced security

NOTE

It is expected that links to an external system are accessible from any device or location, especially the mobile apps.

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 application/json

Example

{
    "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,
    "card_id": "66f6e46c-f6a1-4af8-a1bd-49666bc01304"
}

Request Code 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: <api-key>' \
--header 'x-api-env: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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,
    "card_id": "66f6e46c-f6a1-4af8-a1bd-49666bc01304"
}'

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",
    "card_id": "66f6e46c-f6a1-4af8-a1bd-49666bc01304"
}

🟠404Not Found

🟠401Not Logged In

Modified at 2025-10-30 09:44:22

Upload New Attachment

Retrieve Single Attachment