Update Single Card

Update a single Card

Request

Path Params

collection_id

string

required

card_id

string

required

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Body Params application/json

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

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

optional

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

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

completed_at

string <date-time> | null

optional

Example

{
    "name": "Painting Order 10199",
    "description": "Painting 3x Chair Lissabon Red",
    "start_date": "2020-01-02",
    "start_time": "15:00",
    "end_date": "2020-01-02",
    "end_time": "15:00",
    "custom_fields": [
        {
            "name": "Weight",
            "type": "text",
            "scope": "collection",
            "priority": 0,
            "value": "string",
            "drawing_id": "19ba6f6f-3365-4d74-bdc5-b3df4072c0ab",
            "components": {
                "latitude": 52.3156048,
                "longitude": 6.496432,
                "country": "Netherlands",
                "city": "Rijssen",
                "postal_code": "7462TB",
                "street1": "Hogepad 83",
                "street2": "Second floor"
            },
            "list": [
                {
                    "name": "string",
                    "value": "string",
                    "color": "transparent"
                }
            ],
            "selected": {
                "name": "string",
                "value": "string",
                "color": ""
            },
            "options": {
                "unit": "kg",
                "align": "left",
                "decimals": 2
            }
        }
    ],
    "date": "2020-01-02",
    "start": "2020-01-02",
    "end": "2020-01-02",
    "card_recurring_id": "106de719-5cc0-4af9-bc80-777744f7e20c",
    "parent_card_id": "37909c19-1675-4aa9-a5ad-e2a7cefd2529",
    "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
    "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c",
    "stage_id": "f38d2b9c-0a0a-4eea-91a8-e974413bb670",
    "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
    "completed_at": "2019-08-24T14:15:22Z"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.vplan.com/v1/collection//card/' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Painting Order 10199",
    "description": "Painting 3x Chair Lissabon Red",
    "start_date": "2020-01-02",
    "start_time": "15:00",
    "end_date": "2020-01-02",
    "end_time": "15:00",
    "custom_fields": [
        {
            "name": "Weight",
            "type": "text",
            "scope": "collection",
            "priority": 0,
            "value": "string",
            "drawing_id": "19ba6f6f-3365-4d74-bdc5-b3df4072c0ab",
            "components": {
                "latitude": 52.3156048,
                "longitude": 6.496432,
                "country": "Netherlands",
                "city": "Rijssen",
                "postal_code": "7462TB",
                "street1": "Hogepad 83",
                "street2": "Second floor"
            },
            "list": [
                {
                    "name": "string",
                    "value": "string",
                    "color": "transparent"
                }
            ],
            "selected": {
                "name": "string",
                "value": "string",
                "color": ""
            },
            "options": {
                "unit": "kg",
                "align": "left",
                "decimals": 2
            }
        }
    ],
    "date": "2020-01-02",
    "start": "2020-01-02",
    "end": "2020-01-02",
    "card_recurring_id": "106de719-5cc0-4af9-bc80-777744f7e20c",
    "parent_card_id": "37909c19-1675-4aa9-a5ad-e2a7cefd2529",
    "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
    "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c",
    "stage_id": "f38d2b9c-0a0a-4eea-91a8-e974413bb670",
    "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
    "completed_at": "2019-08-24T14:15:22Z"
}'

Update Single Card

Request

Request samples

Responses