Skip to main content
POST
Create InventoryAsset
An InventoryAsset represents a physical asset — such as a desk, chair, monitor, printer, or other piece of equipment — that a location can track and optionally assign to customers. Each asset belongs to a single location (BusinessId) and can be assigned to a specific scope via AssignToType: Assets may also be assigned to one or more coworkers. The read-only fields CoworkerIds, CoworkerFullNames, CoworkerStartDates, and CoworkerEndDates reflect current assignments. To manage coworker-level assignments, use the CoworkerInventoryAsset entity instead.

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

Request Body

Required Fields

integer
required
ID of the business linked to this record.
string
required
Display name of the asset (e.g. ‘Standing Desk #3’, ‘HP LaserJet’).
integer
required
Determines what this asset is assigned to: Location (1), Resource (2), or FloorPlanItem (3). Defaults to eInventoryAssetAssignToType.Location.

Optional Fields

string
Free-text description of the asset.
string
Stock-keeping unit code for the asset.
string
URL of a new file to upload as the image.
boolean
Set to true to remove the current image file.
number
Monetary value of the asset.
integer
ID of the floor plan desk linked to this record.
integer
ID of the resource linked to this record.

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