Move Collection to Board

POST

/collection/{collection_id}/board/{board_id}

Move a not planned collection to Board and create Cards accordingly

NOTE

Creating cards is an asynchronous process,
new cards are almost but not instantly created

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

{
    "start": "2019-08-24",
    "force_stages": [
        "1ce1e25a-b64d-46d1-b38a-e05fd5717ac0",
        "86bd3ad5-4d76-4aa3-a15a-b0bf0c62d87d",
        "c8d4b144-a29f-480e-a28d-251f5cd8a477"
    ],
    "before": null,
    "after": null,
    "resources": [
        "a225c108-a6ca-4343-8e10-fe10c841a688",
        "d55ca612-5eab-4153-990a-7f7e059b184e",
        "90a8e6da-6bc6-4ff8-95d7-ee73b0908928"
    ],
    "reverse": true,
    "stage_id": "1ce1e25a-b64d-46d1-b38a-e05fd5717ac0",
    "status_id": "3c9fceef-c7ae-4bff-8450-f1a7b4dd47d8"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.vplan.com/v1/collection/d1a15071-f9fa-4514-9939-cafab39ac3c6/board/60ca53ec-f913-41b3-b743-3133a255edfb' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--data-raw '{
    "start": "2019-08-24",
    "force_stages": [
        "1ce1e25a-b64d-46d1-b38a-e05fd5717ac0",
        "86bd3ad5-4d76-4aa3-a15a-b0bf0c62d87d",
        "c8d4b144-a29f-480e-a28d-251f5cd8a477"
    ],
    "before": null,
    "after": null,
    "resources": [
        "a225c108-a6ca-4343-8e10-fe10c841a688",
        "d55ca612-5eab-4153-990a-7f7e059b184e",
        "90a8e6da-6bc6-4ff8-95d7-ee73b0908928"
    ],
    "reverse": true,
    "stage_id": "1ce1e25a-b64d-46d1-b38a-e05fd5717ac0",
    "status_id": "3c9fceef-c7ae-4bff-8450-f1a7b4dd47d8"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "id": "d1a15071-f9fa-4514-9939-cafab39ac3c6",
    "board_id": "60ca53ec-f913-41b3-b743-3133a255edfb",
    "batch_id": null,
    "source_type": "custom",
    "external_ref": null,
    "status": "planned",
    "progress": "open",
    "position": null,
    "start": null,
    "end": null,
    "name": "Order 10199",
    "description": "3x Chair Lissabon",
    "due_date": "2020-01-02",
    "meta": null,
    "custom_fields": [],
    "cover_image_url": null,
    "cover_image_checksum": null,
    "cover_image_signature": null,
    "cover_image_bytes": 0,
    "cover_color_hex": null,
    "created_at": "2025-07-15T06:52:25Z",
    "updated_at": "2025-07-17T13:56:54Z",
    "warnings": []
}

🟠404Not Found

🟠401Not Logged In

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

Remove Single Collection

Move Collection to Backlog