Update a Virtual Entity

PUT

/virtualentity/{id}

Please note that only specific properties of the Virtual Entity can be updated. These includes the following: name, description, location, city, country, postalCodem geoCoordinates, openStreetMapsRef, timeZone.

Request

Authorization

Add parameter in header

token

Example:

token: ********************

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Bodyapplication/json

🟠400Bad request

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/virtualentity/string' \
--header 'Accept: application/json' \
--header 'token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "name": "A new name",
  "description": "This virtual entity represents my home."
}'

Response Example

201 - Created

{
  "status": "OK",
  "veId": "e10591ec-4557-4ac7-90d4-a09654aeb5de"
}

Modified at 2025-09-21 08:26:45

Find Virtual Entity by ID

Delete a Virtual Entity