Update Custom Field By Name

PUT

/collection/{collection_id}/card/{card_id}/custom_fields/{name}

Update a single custom field by name

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

{
    "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/card//custom_fields/' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--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.

🟠404Not Found

🟠401Not Logged In

Modified at 2025-07-22 14:20:42

Card

Delete Custom Field By Name