vPlan
  1. Custom Fields
vPlan
  • General
    • Structure
    • Synchronize Data
    • Pagination
    • Sorting
    • Filtering
    • Show & Hide
    • Eager Loading
    • Deep Insertion
    • Deprecated
    • External Reference
    • Rate Limits
    • Authentication
      • Authentication
        • Get authorization
        • Token Exchange
      • Me
        • Retrieve information about current authentication
    • Errors
      • Empty values in created object
      • Memory Exhausted
      • Report an issue
      • Service Unavailable
      • Retrieve Api Messages
  • Endpoints
    • Base Data
      • Board
        • Label
        • Status
        • Capacity
          • Capacity Stage
          • Capacity Resource Type Stage
          • Capacity Resource
          • Capacity Group
        • Retrieve Board List
        • Create New Board
        • Retrieve Single Board
        • Update Single Board
        • Remove Single Board
      • Stage
        • Retrieve Stage List
        • Create New Stage
        • Retrieve Single Stage
        • Update Single Stage
        • Remove Single Stage
      • Activity
        • Retrieve Activity List
        • Create New Activity
        • Retrieve Single Activity
        • Update Single Activity
        • Remove Single Activity
      • Resource
        • Retrieve Resource List
        • Create New Resource
        • Retrieve Single Resource
        • Update Single Resource
        • Remove Single Resource
      • Schedule
        • Retrieve Schedule List
        • Retrieve Schedule Year
        • Retrieve Schedule Month
        • Schedule Retrieve Day
      • Group
        • Retrieve Group List
        • Create New Group
        • Retrieve Single Group
        • Update Single Group
        • Remove Single Group
      • User
        • Retrieve User List
        • Retrieve Single User
        • Update Single User
    • Card Data
      • Collection
        • Custom Fields
          • Update Custom Field By Name
            PUT
          • Delete Custom Field By Name
            DELETE
        • Retrieve Collection List
          GET
        • Create New Collection
          POST
        • Retrieve Single Collection
          GET
        • Remove Single Collection
          DELETE
        • Move Collection to Backlog
          PUT
        • Update Single Collection
          PUT
        • Move Collection to Board
          POST
      • Card
        • Custom Field
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Card List
        • Create New Card
        • Retrieve Single Card
        • Update Single Card
        • Remove Single Card
        • Split Card
        • All Cards List
      • Attachment
        • Retrieve Attachment List
        • Upload New Attachment
        • Add New Attachment Link
        • Retrieve Single Attachment
        • Remove Single Attachment
      • Comment
        • Retrieve Comment List
        • Create New Comment
        • Retrieve Single Comment
        • Update Single Comment
        • Remove Single Comment
      • Checklist
        • Collection
          • Retrieve Collection Checklist List
          • Create New Collection Checklist
          • Retrieve Single Collection Checklist
          • Update Single Collection Checklist
          • Remove Single Collection Checklist
        • Card
          • Retrieve Card Checklist List
          • Create New Card Checklist
          • Retrieve Single Card Checklist
          • Update Single Card Checklist
          • Remove Single Card Checklist
      • Time Tracking
        • Retrieve TimeTracking List
        • Create New TimeTracking
        • Retrieve Single TimeTracking
        • Update Single TimeTracking
        • Remove Single TimeTracking
        • Export TimeTracking
      • Relations between cards
        • Retrieve CardRelation List
        • Create New CardRelation
        • Retrieve Single CardRelation
        • Remove Single CardRelation
    • Order Data
      • Address
      • Order
        • Retrieve Order List
        • Create New Order
        • Retrieve Single Order
        • Update Single Order
        • Remove Single Order
      • Row
        • Retrieve OrderRow List
        • Create New OrderRow
        • Retrieve Single OrderRow
        • Update Single OrderRow
        • Remove Single OrderRow
      • Item
        • Retrieve Item List
        • Create New Item
        • Retrieve Single Item
        • Update Single Item
        • Remove Single Item
      • Project
        • Retrieve Project List
        • Create New Project
        • Retrieve Single Project
        • Update Single Project
        • Remove Single Project
      • Relation
        • Retrieve Relation List
        • Create New Relation
        • Retrieve Single Relation
        • Update Single Relation
        • Remove Single Relation
      • Warehouse
        • Retrieve Warehouse List
        • Create New Warehouse
        • Retrieve Single Warehouse
        • Update Single Warehouse
        • Remove Single Warehouse
    • Webhook
      • Retrieve Webhook List
      • Create New Webhook
      • Retrieve Single Webhook
      • Update Single Webhook
      • Remove Single Webhook
    • Payload send to webhook url
      • Normal Object
      • Nested Object
      • Nested Object with Pivot
  1. Custom Fields

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:
{{api_key}}
x-api-env
string 
required
Default:
{{api_env}}
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 
optional
Priority of the custom field in which the fields are ordered in the frontend
Example:
0
value
string  | integer  | boolean  | array  | number  | object  | null 
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
Any of
unit
string 
optional
The unit shown as affix or prefix
Example:
kg
align
enum<string> 
optional
Position of the unit
Allowed values:
leftright
Example:
right
decimals
integer 
optional
Number of decimals
Example:
2
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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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
text/plain
Body
null 
optional
🟠422Unprocessable Content
🟠404Not Found
🟠401Not Logged In
Modified at 2024-10-14 12:07:08
Previous
Collection
Next
Delete Custom Field By Name
Built with