vPlan
  1. Activity
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
        • 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
          GET
        • Create New Activity
          POST
        • Retrieve Single Activity
          GET
        • Update Single Activity
          PUT
        • Remove Single Activity
          DELETE
      • 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. Activity

Create New Activity

POST
/activity
Activity
Create a new Activity and store it

Request

Query Params
show
string 
optional
Show only specific properties from the response. More info show & hide
hide
string 
optional
Hide properties from the response. More info show & hide
Header Params
x-api-key
string 
required
Default:
{{api_key}}
x-api-env
string 
required
Default:
{{api_env}}
Body Params application/json
description
string 
optional
code
string 
optional
item_id
string <uuid>
optional
resource_type
enum<string> 
optional
Allowed values:
machinecellemployee
Default:
resource
default_duration
integer 
optional
day_max_duration
integer 
optional
billable
boolean 
optional
hourly_rate
integer 
optional
stages
array [object]  | null 
optional
Example
{
    "id": "e4307a66-a249-4c93-883c-5031f4be1c73",
    "description": "Viriliter balbus eaque comprehendo strues sophismata tunc atrocitas attonbitus super. Aequus suspendo comminor videlicet aveho curto at virtus terra. Subnecto tergeo corrupti calcar. Debilito arto aeneus degusto dicta depopulo tener dolore. Deserunt doloribus candidus concido distinctio venustas aqua. Adsuesco possimus curvo taceo timidus annus tertius viduo laboriosam.",
    "code": "75",
    "item_id": "0beb59b0-4616-4718-a1fe-6f61c5ed6334",
    "resource_type": "cell",
    "default_duration": -7381567,
    "day_max_duration": 17276729,
    "billable": true,
    "hourly_rate": 45400847,
    "external_ref": "fb1033a2ed70",
    "created_at": "2024-04-11T10:22:15Z",
    "updated_at": "2024-04-11T10:22:15Z"
}

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/activity?show=&hide=' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "e4307a66-a249-4c93-883c-5031f4be1c73",
    "description": "Viriliter balbus eaque comprehendo strues sophismata tunc atrocitas attonbitus super. Aequus suspendo comminor videlicet aveho curto at virtus terra. Subnecto tergeo corrupti calcar. Debilito arto aeneus degusto dicta depopulo tener dolore. Deserunt doloribus candidus concido distinctio venustas aqua. Adsuesco possimus curvo taceo timidus annus tertius viduo laboriosam.",
    "code": "75",
    "item_id": "0beb59b0-4616-4718-a1fe-6f61c5ed6334",
    "resource_type": "cell",
    "default_duration": -7381567,
    "day_max_duration": 17276729,
    "billable": true,
    "hourly_rate": 45400847,
    "external_ref": "fb1033a2ed70",
    "created_at": "2024-04-11T10:22:15Z",
    "updated_at": "2024-04-11T10:22:15Z"
}'

Responses

🟢201Created
application/json
Body
id
string <uuid>
read-onlyoptional
Unique identifier
description
string 
optional
code
string 
optional
item_id
string <uuid>
optional
resource_type
enum<string> 
optional
Allowed values:
machinecellemployee
Default:
resource
default_duration
integer 
optional
day_max_duration
integer 
optional
billable
boolean 
optional
hourly_rate
integer 
optional
external_ref
string  | null 
read-onlyoptional
Third-party reference of the object, for informational purposes only
Example:
fb1033a2ed70
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>
read-onlyoptional
Date and time that the object is archived
Example:
2021-07-06T11:24:35Z
Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string",
    "code": "string",
    "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
    "resource_type": "resource",
    "default_duration": 0,
    "day_max_duration": 0,
    "billable": true,
    "hourly_rate": 0,
    "external_ref": "fb1033a2ed70",
    "created_at": "2024-04-11T10:22:15Z",
    "updated_at": "2024-04-11T10:22:15Z",
    "archived_at": "2021-07-06T11:24:35Z"
}
🟠422Unprocessable Content
🟠401Not Logged In
Modified at 2025-06-25 08:40:51
Previous
Retrieve Activity List
Next
Retrieve Single Activity
Built with