vPlan
  1. Endpoints
  2. Base Data
  3. Resource
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
          GET
        • Create New Resource
          POST
        • Retrieve Single Resource
          GET
        • Update Single Resource
          PUT
        • Remove Single Resource
          DELETE
      • 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
          • Delete Custom Field By Name
        • Retrieve Collection List
        • Create New Collection
        • Retrieve Single Collection
        • Update Single Collection
        • Remove Single Collection
        • Move Collection to Backlog
        • Move Collection to Board
      • Card
        • Custom Field
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Card List
        • All Cards List
        • Create New Card
        • Retrieve Single Card
        • Update Single Card
        • Remove Single Card
        • Split Card
      • 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. Endpoints
  2. Base Data
  3. Resource

Update Single Resource

PUT
/resource/{resource_id}
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:
{{api_key}}
x-api-env
string 
required
Default:
{{api_env}}
Body Params application/json
name
string 
optional
type
enum<string> 
optional
Allowed values:
resourcemachinecell
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
1
integer  | null 
required
2
integer  | null 
required
3
integer  | null 
required
4
integer  | null 
required
5
integer  | null 
required
6
integer  | null 
required
7
integer  | null 
required
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}$
Example

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/resource/' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢204No Content
text/plain
Body
object {0}
🟠422Unprocessable Content
🟠404Not Found
🟠401Not Logged In
Modified at 2024-10-14 12:07:08
Previous
Retrieve Single Resource
Next
Remove Single Resource
Built with