Skip to main content
POST
Create CoworkerInventoryAsset
A customer equipment assignment links one customer to one equipment item at a location, with a required start and optional end date; use it for assignment history, planned returns, or notes rather than editing the equipment item’s read-only assignment summaries.

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 CoworkerInventoryAsset-Create role.

Request Body

Required Fields

integer
required
ID of the customer receiving the equipment item; the customer must be accessible to the current user..
integer
required
ID of the location where this customer equipment assignment applies..
integer
required
ID of the equipment item assigned to the customer; a customer cannot have more than one active assignment for the same item..
string
required
Required assignment start date and time; the server rejects the record when it is not supplied..

Optional Fields

string
Optional internal notes about this customer equipment assignment..
string
Optional assignment end date and time, which cannot be earlier than AssignedFrom; null keeps the assignment active..

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 coworkerinventoryasset 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