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

Create New Board

POST
/board
Create a new Board and store it

Request

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 {11}] 
optional
id
string <uuid>
optional
Unique identifier
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 {3}] 
optional
id
string <uuid>
optional
Unique identifier
name
string 
required
color
enum<string> 
optional
Allowed values:
bluebrownbubblegumcharcoalgreengreyindigolavendernavyoliveorangepinkpurpleraspberryredrubyskybluetealtransparentyellow
Default:
transparent
statusses
array [object {6}] 
optional
>= 2 items
id
string <uuid>
optional
Unique identifier
name
string 
required
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": "string",
    "workdays": {
        "1": true,
        "2": true,
        "3": true,
        "4": true,
        "5": true,
        "6": false,
        "7": false
    },
    "color": "transparent",
    "split_cards_by_activity": false,
    "own_backlog": false,
    "capacity_method": "estimated_time",
    "visibility": "everyone",
    "restricted_users": [
        {
            "id": "string",
            "permission_set": "board_admin"
        }
    ],
    "dependency_behavior": "notify",
    "custom_fields": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "Weight",
            "type": "text",
            "scope": "collection",
            "priority": 0,
            "value": "string",
            "drawing_id": "19ba6f6f-3365-4d74-bdc5-b3df4072c0ab",
            "components": {
                "latitude": 52.3156048,
                "longitude": 6.496432,
                "country": "Netherlands",
                "city": "Rijssen",
                "postal_code": "7462TB",
                "street1": "Hogepad 83",
                "street2": "Second floor"
            },
            "list": [
                {
                    "name": "string",
                    "value": "string",
                    "color": "transparent"
                }
            ],
            "selected": {
                "name": "string",
                "value": "string",
                "color": ""
            },
            "options": {
                "unit": "kg",
                "align": "left",
                "decimals": 2
            }
        }
    ],
    "labels": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "color": "transparent"
        }
    ],
    "statusses": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "priority": 0,
            "entry": true,
            "exit": true,
            "color": "transparent"
        },
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "priority": 0,
            "entry": true,
            "exit": true,
            "color": "transparent"
        }
    ]
}

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 POST 'https://api.vplan.com/v1/board' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "workdays": {
        "1": true,
        "2": true,
        "3": true,
        "4": true,
        "5": true,
        "6": false,
        "7": false
    },
    "color": "transparent",
    "split_cards_by_activity": false,
    "own_backlog": false,
    "capacity_method": "estimated_time",
    "visibility": "everyone",
    "restricted_users": [
        {
            "id": "string",
            "permission_set": "board_admin"
        }
    ],
    "dependency_behavior": "notify",
    "custom_fields": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "Weight",
            "type": "text",
            "scope": "collection",
            "priority": 0,
            "value": "string",
            "drawing_id": "19ba6f6f-3365-4d74-bdc5-b3df4072c0ab",
            "components": {
                "latitude": 52.3156048,
                "longitude": 6.496432,
                "country": "Netherlands",
                "city": "Rijssen",
                "postal_code": "7462TB",
                "street1": "Hogepad 83",
                "street2": "Second floor"
            },
            "list": [
                {
                    "name": "string",
                    "value": "string",
                    "color": "transparent"
                }
            ],
            "selected": {
                "name": "string",
                "value": "string",
                "color": ""
            },
            "options": {
                "unit": "kg",
                "align": "left",
                "decimals": 2
            }
        }
    ],
    "labels": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "color": "transparent"
        }
    ],
    "statusses": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "priority": 0,
            "entry": true,
            "exit": true,
            "color": "transparent"
        },
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "priority": 0,
            "entry": true,
            "exit": true,
            "color": "transparent"
        }
    ]
}'

Responses

đŸŸ¢201Created
application/json
Body
id
string <uuid>
read-onlyoptional
Unique identifier
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
dependency_behavior
enum<string> 
optional
Allowed values:
notifypushmaintain
Default:
notify
custom_fields
array[object (CustomField) {13}] 
optional
id
string <uuid>
read-onlyoptional
Unique identifier
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
created_at
string <date-time>
read-onlyoptional
Date and time of creation
Example:
2024-04-11T10:22:15Z
updated_at
string <date-time>
read-onlyoptional
Date and time of last update
Example:
2024-04-11T10:22:15Z
created_at
string <date-time>
read-onlyoptional
Date and time of creation
Example:
2024-04-11T10:22:15Z
updated_at
string <date-time>
read-onlyoptional
Date and time of last update
Example:
2024-04-11T10:22:15Z
archived_at
string <date-time> | null 
read-onlyoptional
Date and time that the object is archived
Example:
null
Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "workdays": {
        "1": true,
        "2": true,
        "3": true,
        "4": true,
        "5": true,
        "6": false,
        "7": false
    },
    "color": "transparent",
    "split_cards_by_activity": false,
    "own_backlog": false,
    "capacity_method": "estimated_time",
    "visibility": "everyone",
    "dependency_behavior": "notify",
    "custom_fields": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "Weight",
            "type": "text",
            "scope": "collection",
            "priority": 0,
            "value": "string",
            "drawing_id": "19ba6f6f-3365-4d74-bdc5-b3df4072c0ab",
            "components": {
                "latitude": 52.3156048,
                "longitude": 6.496432,
                "country": "Netherlands",
                "city": "Rijssen",
                "postal_code": "7462TB",
                "street1": "Hogepad 83",
                "street2": "Second floor"
            },
            "list": [
                {
                    "name": "string",
                    "value": "string",
                    "color": "transparent"
                }
            ],
            "selected": {
                "name": "string",
                "value": "string",
                "color": ""
            },
            "options": {
                "unit": "kg",
                "align": "left",
                "decimals": 2
            },
            "created_at": "2024-04-11T10:22:15Z",
            "updated_at": "2024-04-11T10:22:15Z"
        }
    ],
    "created_at": "2024-04-11T10:22:15Z",
    "updated_at": "2024-04-11T10:22:15Z",
    "archived_at": null
}
đŸŸ 403Forbidden
đŸŸ 422Unprocessable Content
đŸŸ 401Not Logged In
Modified at 2025-05-26 13:17:47
Previous
Retrieve Board List
Next
Retrieve Single Board
Built with