InventoryAssets
Create InventoryAsset
Create a new InventoryAsset record.
POST
Create InventoryAsset
An InventoryAsset is a location-owned physical item, such as a desk, chair, monitor, or printer, tracked at the location, a bookable resource, or a floor-plan desk. Customer assignments are managed as separate CoworkerInventoryAsset records.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the InventoryAsset-Create role.Enums
eInventoryAssetAssignToType — AssignToType values
eInventoryAssetAssignToType — AssignToType values
Request Body
Required Fields
integer
required
ID of the location that owns this asset; saving a linked resource or floor-plan desk can replace it with that linked record’s location..
string
required
Required display name of the physical asset, such as ‘Standing Desk #3’ or ‘HP LaserJet’..
integer
required
Determines the asset scope: Location (1) needs no linked resource or desk, Resource (2) requires ResourceId, and FloorPlanItem (3) requires FloorPlanDeskId.. Defaults to
eInventoryAssetAssignToType.Location.Optional Fields
string
Optional free-text description of the asset..
string
Optional stock-keeping unit code; when provided, it must be unique within the location..
string
URL of a new file to upload as the image.
boolean
Set to true to remove the current image file.
number
Optional monetary value of the asset in the owning location’s currency..
integer
ID of the floor-plan desk linked to this asset; required when AssignToType is FloorPlanItem and it sets the asset’s location from the desk’s floor plan..
integer
ID of the bookable resource linked to this asset; required when AssignToType is Resource and it sets the asset’s location to the resource’s location..
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the creation.
object
Contains the
Id of the newly created record.boolean
true if the inventoryasset was created successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response