Update Custom Field By Name

PUT

/collection/{collection_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

{
    "board_id": "46926704-5380-e8fe-f0e6-dac91794ec7a",
    "value": "consectetur non laboris",
    "options": {
        "format": "2025-07-16T21:18:50.455Z"
    }
}

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 'Content-Type: application/json' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--data-raw '{
    "board_id": "46926704-5380-e8fe-f0e6-dac91794ec7a",
    "value": "consectetur non laboris",
    "options": {
        "format": "2025-07-16T21:18:50.455Z"
    }
}'

Responses

🟢204No Content

This response does not have a body.

🟠404Not Found

🟠401Not Logged In

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

Collection

Delete Custom Field By Name