vPlan
  1. Board
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
        • View
          • Create New BoardView
        • Retrieve Board List
          GET
        • Create New Board
          POST
        • Retrieve Single Board
          GET
        • Update Single Board
          PUT
        • Remove Single Board
          DELETE
      • 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
        • Schedule
        • Schedule Deviation
          • Retrieve Deviation List
          • Create New Schedule Deviation
          • Retrieve Single Schedule Deviation
          • Update Single Schedule Deviation
          • Remove Single Schedule Deviation
        • 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
        • Invite User
        • Retrieve User List
        • Retrieve Single User
        • Update Single User
    • Card Data
      • Collection
        • Custom Fields
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Collection List
        • Create New Collection
        • Retrieve Single Collection
        • Remove Single Collection
        • Move Collection to Backlog
        • Update Single Collection
        • Move Collection to Board
      • 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. Board

Update Single Board

PUT
/board/{board_id}
Update a single Board

Request

Path Params
board_id
string <uuid>
required
Example:
550e8400-e29b-41d4-a716-446655440000
Query Params
update_without_delete_nested
boolean 
optional
Only add/update related entities. Entities which are not passed will not be removed if this value is true.
Default:
false
Example:
true
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
workdays
object (BoardWorkdays) 
optional
1
boolean 
required
Default:
true
2
boolean 
required
Default:
true
3
boolean 
required
Default:
true
4
boolean 
required
Default:
true
5
boolean 
required
Default:
true
6
boolean 
required
Default:
false
7
boolean 
required
Default:
false
color
enum<string> 
optional
Allowed values:
bluebrownbubblegumcharcoalgreengreyindigolavendernavyoliveorangepinkpurpleraspberryredrubyskybluetealtransparentyellow
Default:
transparent
split_cards_by_activity
boolean 
optional
Default:
false
own_backlog
boolean 
optional
Default:
false
capacity_method
enum<string> 
optional
Allowed values:
estimated_timenoneremaining_time
Default:
estimated_time
visibility
enum<string> 
optional
Allowed values:
everyonerestricted
Default:
everyone
restricted_users
array [object {2}] 
write-onlyoptional
id
string 
optional
permission_set
enum<string> 
optional
Allowed values:
board_admineditorexecutorcomment_only
dependency_behavior
enum<string> 
optional
Allowed values:
notifypushmaintain
Default:
notify
custom_fields
array[object (CustomField) {10}] 
optional
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
list
array [object {3}] 
optional
selected
object 
optional
options
optional
Extra settings for number, select or list types
labels
array[object (Label) {2}] 
optional
name
string 
required
color
enum<string> 
optional
Allowed values:
bluebrownbubblegumcharcoalgreengreyindigolavendernavyoliveorangepinkpurpleraspberryredrubyskybluetealtransparentyellow
Default:
transparent
statusses
array [object {5}] 
optional
name
string 
optional
priority
integer 
optional
Priority used for sorting this object
entry
boolean 
optional
Switch to show if this is the first status in a board
exit
boolean 
optional
Switch to show if this is the last status in a board
color
enum<string> 
optional
Allowed values:
bluebrownbubblegumcharcoalgreengreyindigolavendernavyoliveorangepinkpurpleraspberryredrubyskybluetealtransparentyellow
Default:
transparent
Example
{
    "name": "other_name",
    "custom_fields": [
        {
            "id": "836e4449-bc57-4b65-b62e-bf531e2499ae",
            "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f",
            "name": "user field (card)",
            "type": "users",
            "scope": "card",
            "options": {
                "multiple": false,
                "values": [
                    {
                        "user_id": "57fa913e-eff2-459f-8b8d-5cbe48613135"
                    }
                ]
            },
            "priority": 1,
            "created_at": "2024-06-24T10:02:48Z",
            "updated_at": "2024-06-24T14:40:47Z"
        },
        {
            "id": "e01992aa-194c-4c4f-ab7a-c2a7cdf2f728",
            "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f",
            "name": "users field (card)",
            "type": "users",
            "scope": "card",
            "options": {
                "multiple": true,
                "values": [
                    {
                        "fullname": "Quentin Correia",
                        "user_id": "57fa913e-eff2-459f-8b8d-5cbe48613135",
                        "avatar": "https://fs.test.mostwanted.io/api/v1/project/42a0b7c5-3b9b-4755-9e92-54bdd3360b98/file/0340e241-c054-43ba-938c-31a7e845a80a?s=FpF2GkJd&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2ZzLnRlc3QubW9zdHdhbnRlZC5pby8iLCJzdWIiOiJ2cGxhbi1kZXYtcmVhZCIsImlhdCI6MTcxOTIxMzU2OCwibmJmIjoxNzE5MjEzNTY4LCJqdGkiOiI5ZjMwNDM3MC05ZjgwLTRkNmEtOTY4NC1jMDY3NDVjNDE5NTEifQ.VcgQyT516euaO3h_Zf-FPH1fsoY5bbcciWAUZOJU42M"
                    }
                ]
            },
            "priority": 1,
            "created_at": "2024-06-24T10:02:48Z",
            "updated_at": "2024-06-24T13:36:52Z"
        },
        {
            "id": "909b8ded-cb3f-495f-8eaa-d1712aa21a03",
            "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f",
            "name": "users field (collection)",
            "type": "users",
            "scope": "collection",
            "options": {
                "multiple": true,
                "values": [
                    {
                        "fullname": "Quentin Correia",
                        "user_id": "57fa913e-eff2-459f-8b8d-5cbe48613135",
                        "avatar": "https://fs.test.mostwanted.io/api/v1/project/42a0b7c5-3b9b-4755-9e92-54bdd3360b98/file/0340e241-c054-43ba-938c-31a7e845a80a?s=FpF2GkJd&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2ZzLnRlc3QubW9zdHdhbnRlZC5pby8iLCJzdWIiOiJ2cGxhbi1kZXYtcmVhZCIsImlhdCI6MTcxOTIxMzU2OCwibmJmIjoxNzE5MjEzNTY4LCJqdGkiOiI5ZjMwNDM3MC05ZjgwLTRkNmEtOTY4NC1jMDY3NDVjNDE5NTEifQ.VcgQyT516euaO3h_Zf-FPH1fsoY5bbcciWAUZOJU42M"
                    }
                ]
            },
            "priority": 2,
            "created_at": "2024-06-24T10:02:48Z",
            "updated_at": "2024-06-24T13:36:52Z"
        },
        {
            "id": "9522c642-2a9a-4d5e-868e-2be9c2d2f28d",
            "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f",
            "name": "user field (collection)",
            "type": "users",
            "scope": "collection",
            "options": {
                "multiple": false,
                "values": [
                    {
                        "fullname": "Quentin Correia",
                        "user_id": "57fa913e-eff2-459f-8b8d-5cbe48613135",
                        "avatar": "https://fs.test.mostwanted.io/api/v1/project/42a0b7c5-3b9b-4755-9e92-54bdd3360b98/file/0340e241-c054-43ba-938c-31a7e845a80a?s=FpF2GkJd&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2ZzLnRlc3QubW9zdHdhbnRlZC5pby8iLCJzdWIiOiJ2cGxhbi1kZXYtcmVhZCIsImlhdCI6MTcxOTIxMzU2OCwibmJmIjoxNzE5MjEzNTY4LCJqdGkiOiI5ZjMwNDM3MC05ZjgwLTRkNmEtOTY4NC1jMDY3NDVjNDE5NTEifQ.VcgQyT516euaO3h_Zf-FPH1fsoY5bbcciWAUZOJU42M"
                    }
                ]
            },
            "priority": 2,
            "created_at": "2024-06-24T10:02:48Z",
            "updated_at": "2024-06-24T13:36:52Z"
        }
    ]
}

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/board/550e8400-e29b-41d4-a716-446655440000' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "other_name",
    "custom_fields": [
        {
            "id": "836e4449-bc57-4b65-b62e-bf531e2499ae",
            "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f",
            "name": "user field (card)",
            "type": "users",
            "scope": "card",
            "options": {
                "multiple": false,
                "values": [
                    {
                        "user_id": "57fa913e-eff2-459f-8b8d-5cbe48613135"
                    }
                ]
            },
            "priority": 1,
            "created_at": "2024-06-24T10:02:48Z",
            "updated_at": "2024-06-24T14:40:47Z"
        },
        {
            "id": "e01992aa-194c-4c4f-ab7a-c2a7cdf2f728",
            "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f",
            "name": "users field (card)",
            "type": "users",
            "scope": "card",
            "options": {
                "multiple": true,
                "values": [
                    {
                        "fullname": "Quentin Correia",
                        "user_id": "57fa913e-eff2-459f-8b8d-5cbe48613135",
                        "avatar": "https://fs.test.mostwanted.io/api/v1/project/42a0b7c5-3b9b-4755-9e92-54bdd3360b98/file/0340e241-c054-43ba-938c-31a7e845a80a?s=FpF2GkJd&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2ZzLnRlc3QubW9zdHdhbnRlZC5pby8iLCJzdWIiOiJ2cGxhbi1kZXYtcmVhZCIsImlhdCI6MTcxOTIxMzU2OCwibmJmIjoxNzE5MjEzNTY4LCJqdGkiOiI5ZjMwNDM3MC05ZjgwLTRkNmEtOTY4NC1jMDY3NDVjNDE5NTEifQ.VcgQyT516euaO3h_Zf-FPH1fsoY5bbcciWAUZOJU42M"
                    }
                ]
            },
            "priority": 1,
            "created_at": "2024-06-24T10:02:48Z",
            "updated_at": "2024-06-24T13:36:52Z"
        },
        {
            "id": "909b8ded-cb3f-495f-8eaa-d1712aa21a03",
            "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f",
            "name": "users field (collection)",
            "type": "users",
            "scope": "collection",
            "options": {
                "multiple": true,
                "values": [
                    {
                        "fullname": "Quentin Correia",
                        "user_id": "57fa913e-eff2-459f-8b8d-5cbe48613135",
                        "avatar": "https://fs.test.mostwanted.io/api/v1/project/42a0b7c5-3b9b-4755-9e92-54bdd3360b98/file/0340e241-c054-43ba-938c-31a7e845a80a?s=FpF2GkJd&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2ZzLnRlc3QubW9zdHdhbnRlZC5pby8iLCJzdWIiOiJ2cGxhbi1kZXYtcmVhZCIsImlhdCI6MTcxOTIxMzU2OCwibmJmIjoxNzE5MjEzNTY4LCJqdGkiOiI5ZjMwNDM3MC05ZjgwLTRkNmEtOTY4NC1jMDY3NDVjNDE5NTEifQ.VcgQyT516euaO3h_Zf-FPH1fsoY5bbcciWAUZOJU42M"
                    }
                ]
            },
            "priority": 2,
            "created_at": "2024-06-24T10:02:48Z",
            "updated_at": "2024-06-24T13:36:52Z"
        },
        {
            "id": "9522c642-2a9a-4d5e-868e-2be9c2d2f28d",
            "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f",
            "name": "user field (collection)",
            "type": "users",
            "scope": "collection",
            "options": {
                "multiple": false,
                "values": [
                    {
                        "fullname": "Quentin Correia",
                        "user_id": "57fa913e-eff2-459f-8b8d-5cbe48613135",
                        "avatar": "https://fs.test.mostwanted.io/api/v1/project/42a0b7c5-3b9b-4755-9e92-54bdd3360b98/file/0340e241-c054-43ba-938c-31a7e845a80a?s=FpF2GkJd&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2ZzLnRlc3QubW9zdHdhbnRlZC5pby8iLCJzdWIiOiJ2cGxhbi1kZXYtcmVhZCIsImlhdCI6MTcxOTIxMzU2OCwibmJmIjoxNzE5MjEzNTY4LCJqdGkiOiI5ZjMwNDM3MC05ZjgwLTRkNmEtOTY4NC1jMDY3NDVjNDE5NTEifQ.VcgQyT516euaO3h_Zf-FPH1fsoY5bbcciWAUZOJU42M"
                    }
                ]
            },
            "priority": 2,
            "created_at": "2024-06-24T10:02:48Z",
            "updated_at": "2024-06-24T13:36:52Z"
        }
    ]
}'

Responses

đŸŸ¢204No Content
This response does not have a body.
đŸŸ 422Unprocessable Content
đŸŸ 404Not Found
đŸŸ 401Not Logged In
Modified at 2025-04-22 11:37:34
Previous
Retrieve Single Board
Next
Remove Single Board
Built with