vPlan

Update Single Collection

PUT

/collection/{collection_id}

Collection

Update a single Collection

Request

Path Params

collection_id

string

required

Example:

83271353-458f-4ce1-8c15-ce9a3a9a3ad9

Query Params

update_without_delete_nested

boolean

optional

Example:

false

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Body Params application/json

name

string

optional

Example:

Order 10199

description

string | null

optional

Example:

3x Chair Lissabon

due_date

string <date> | null

optional

Example:

2020-01-02

status

enum<string>

optional

Status of the collection

planned

collection is planned, and has cards visible on a board

not_planned

collection is on backlog

ignored

collection is in the archive

WARNING

On update the status can only be changed from ignored to not_planned or from not_planned to ignored.

For other actions please look at:

Move Collection to Backlog

Move Collection to Board

Allowed values:

plannednot_plannedignored

Example:

not_planned

custom_fields

array[object (CustomField) {10}]

required

name

string

optional

Name of the field

Example:

Weight

type

enum<string>

optional

Allowed values:

textnumberdatecheckboxemaillinkphonelistselectaddressdrawingtextareausers

Default:

text

Example:

number

scope

enum<string>

optional

Allowed values:

collectioncard

priority

integer

required

Priority of the custom field in which the fields are ordered in the frontend

Example:

value

optional

drawing_id

string <uuid>

optional

components

object (CustomFieldOptionsAddress)

optional

list

array [object {3}]

optional

selected

object

optional

options

optional

Extra settings for number, select or list types

board_id

string <uuid>

required

Unique identifier of the Board

cover_image_url

string <uri> | null

optional

cover_image_checksum

string | null

write-onlyoptional

Match pattern:

^[a-fA-F0-9]{64}$

cover_color_hex

string | null

optional

Examples:

#FFF#8d46e0

Match pattern:

^#([A-Fa-f0-9]{3}){1,2}$

cards

array [object {16}]

required

name

string

optional

Name specific for a Card

NOTE

Collection has a name global for all cards, however a Card can have a specific name different from the rest.

Update the Collection name to update it for every Card.

Example:

Painting Order 10199

description

string

optional

Description specific for a Card

NOTE

Collection has a description global for all cards, however a Card can have a specific description different from the rest.

Update the Collection description to update it for every Card.

Example:

Painting 3x Chair Lissabon Red

start_date

string <date> | null

optional

Default:

2020-01-02

start_time

string <time> | null

optional

Default:

15:00

end_date

string <date> | null

optional

Default:

2020-01-02

end_time

string <time> | null

optional

Default:

15:00

custom_fields

array[object (CustomField) {10}]

required

date

string <date> | null

deprecated

Default:

2020-01-02

start

string <date> | null

deprecated

Default:

2020-01-02

end

string <date> | null

deprecated

Default:

2020-01-02

card_recurring_id

string <uuid> | null

optional

Link to the recurring occurrence

parent_card_id

string <uuid> | null

optional

Link to the parent card

collection_id

string <uuid>

required

Link to the collection

status_id

string <uuid>

required

Link to the status

stage_id

string <uuid>

required

Link to the stage

batch_id

string <uuid> | null

optional

Internal used field

Example

{
    "name": "card 2",
    "cards": [
        {
            "id": "cc2b196d-c651-4e27-be40-8ae7e1c66a72",
            "custom_fields": [
                {
                    "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f",
                    "name": "bestaat niet",
                    "type": "text",
                    "scope": "card",
                    "priority": 5,
                    "value": "rare keuze"
                },
                {
                    "id": "4f96ed6d-b863-4267-bc2c-618bd52a59fd",
                    "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f",
                    "name": "test 1",
                    "type": "text",
                    "scope": "card",
                    "priority": 4,
                    "value": "hehe"
                }
            ]
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.vplan.com/v1/collection/83271353-458f-4ce1-8c15-ce9a3a9a3ad9' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "card 2",
    "cards": [
        {
            "id": "cc2b196d-c651-4e27-be40-8ae7e1c66a72",
            "custom_fields": [
                {
                    "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f",
                    "name": "bestaat niet",
                    "type": "text",
                    "scope": "card",
                    "priority": 5,
                    "value": "rare keuze"
                },
                {
                    "id": "4f96ed6d-b863-4267-bc2c-618bd52a59fd",
                    "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f",
                    "name": "test 1",
                    "type": "text",
                    "scope": "card",
                    "priority": 4,
                    "value": "hehe"
                }
            ]
        }
    ]
}'

Responses

🟢204No Content

text/plain

Body

null

optional

🟠422Unprocessable Content

🟠404Not Found

🟠401Not Logged In

Modified at 2025-04-22 11:37:34

Move Collection to Backlog

Move Collection to Board