Update Single Resource

Update a single Resource

WARNING

An update of a resource will always trigger an async process to rebuild all schedules for that resource.
Any manual changes made to the schedules between the start and end date of the resource will not persist.

Request

Path Params

resource_id

string <uuid>

required

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Body Params application/json

name

string

optional

type

enum<string>

optional

Allowed values:

machinecellemployee

Default:

resource

description

string

optional

start_date

string <date>

optional

end_date

string <date> | null

optional

avatar

string <uri> | null

optional

workdays

object (ResourceWorkdays)

optional

Days of the week that are considered workdays

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

null

integer | null

required

>= 0<= 24

Default:

null

integration_schedule

boolean

optional

If false, vPlan manages the schedules via workdays. When true, integration manages the schedules

color_hex

string

optional

Color hex is used to signify the Resource, only used if the avatar is null

Match pattern:

^#([0-9a-f]{3}){1,2}$

boards

array [object {3}]

required

string <uuid>

required

Unique identifier

stages

array [object {3}]

required

active

boolean

optional

Example

{
    "name": "Lorenzo Zulauf",
    "type": "cell",
    "description": "Vulgivagus tempore defaeco decumbo adulescens. Valens tribuo claro verus porro somniculosus.",
    "start_date": "2025-11-13",
    "end_date": "2025-05-27",
    "avatar": "https://avatars.githubusercontent.com/u/78745669",
    "workdays": {
        "1": 17,
        "2": 1,
        "3": 23,
        "4": 23,
        "5": 17,
        "6": 6,
        "7": 6
    },
    "integration_schedule": false,
    "color_hex": "#a8a",
    "boards": [
        {
            "id": "5edec42b-cdae-4ee9-a2ac-fc979c9b5090",
            "stages": [
                {
                    "id": "12df4395-7501-4865-9be6-abe2dac6edbf",
                    "percentage": 642,
                    "active": true
                },
                {
                    "id": "12df4395-7501-4865-9be6-abe2dac6edbf",
                    "percentage": 642,
                    "active": true
                },
                {
                    "id": "12df4395-7501-4865-9be6-abe2dac6edbf",
                    "percentage": 642,
                    "active": true
                }
            ],
            "active": true
        },
        {
            "id": "5edec42b-cdae-4ee9-a2ac-fc979c9b5090",
            "stages": [
                {
                    "id": "12df4395-7501-4865-9be6-abe2dac6edbf",
                    "percentage": 642,
                    "active": true
                },
                {
                    "id": "12df4395-7501-4865-9be6-abe2dac6edbf",
                    "percentage": 642,
                    "active": true
                },
                {
                    "id": "12df4395-7501-4865-9be6-abe2dac6edbf",
                    "percentage": 642,
                    "active": true
                }
            ],
            "active": true
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.vplan.com/v1/resource/' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Lorenzo Zulauf",
    "type": "cell",
    "description": "Vulgivagus tempore defaeco decumbo adulescens. Valens tribuo claro verus porro somniculosus.",
    "start_date": "2025-11-13",
    "end_date": "2025-05-27",
    "avatar": "https://avatars.githubusercontent.com/u/78745669",
    "workdays": {
        "1": 17,
        "2": 1,
        "3": 23,
        "4": 23,
        "5": 17,
        "6": 6,
        "7": 6
    },
    "integration_schedule": false,
    "color_hex": "#a8a",
    "boards": [
        {
            "id": "5edec42b-cdae-4ee9-a2ac-fc979c9b5090",
            "stages": [
                {
                    "id": "12df4395-7501-4865-9be6-abe2dac6edbf",
                    "percentage": 642,
                    "active": true
                },
                {
                    "id": "12df4395-7501-4865-9be6-abe2dac6edbf",
                    "percentage": 642,
                    "active": true
                },
                {
                    "id": "12df4395-7501-4865-9be6-abe2dac6edbf",
                    "percentage": 642,
                    "active": true
                }
            ],
            "active": true
        },
        {
            "id": "5edec42b-cdae-4ee9-a2ac-fc979c9b5090",
            "stages": [
                {
                    "id": "12df4395-7501-4865-9be6-abe2dac6edbf",
                    "percentage": 642,
                    "active": true
                },
                {
                    "id": "12df4395-7501-4865-9be6-abe2dac6edbf",
                    "percentage": 642,
                    "active": true
                },
                {
                    "id": "12df4395-7501-4865-9be6-abe2dac6edbf",
                    "percentage": 642,
                    "active": true
                }
            ],
            "active": true
        }
    ]
}'

Update Single Resource

Request

Request samples

Responses