vPlan

Update Custom Field By Name

PUT

/collection/{collection_id}/custom_fields/{name}

Collection

Update a single custom field by name

Request

Path Params

collection_id

string

required

Example:

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

name

string

required

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Body Params application/json

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

latitude

number

optional

The geographic coordinate that specifies the north–south position

Example:

52.3156048

longitude

number

optional

The geographic coordinate that specifies the east-west position

Example:

6.496432

country

string

optional

The country of the location

Example:

Netherlands

city

string

optional

The city of the location

Example:

Rijssen

postal_code

string

optional

The postcode of the location

Example:

7462TB

street1

string

optional

The first line of the street address

Example:

Hogepad 83

street2

string

optional

The second line of the street address

Example:

Second floor

list

array [object {3}]

optional

name

string

required

value

string

required

color

enum<string>

required

Allowed values:

bluebrownbubblegumcharcoalgreengreyindigolavendernavyoliveorangepinkpurpleraspberryredrubyskybluetealtransparentyellow

Default:

transparent

selected

object

optional

name

string

required

value

string

required

color

enum<string>

required

Allowed values:

bluebrownbubblegumcharcoalgreengreyindigolavendernavyoliveorangepinkpurpleraspberryredrubyskybluetealtransparentyellow

options

optional

Extra settings for number, select or list types

unit

string

optional

The unit shown as affix or prefix

Example:

align

enum<string>

optional

Position of the unit

Allowed values:

leftright

Example:

right

decimals

integer

optional

Number of decimals

Example:

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/custom_fields/' \
--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

This response does not have a body.

🟠422Unprocessable Content

🟠404Not Found

🟠401Not Logged In

Collection

Delete Custom Field By Name