Update an entity

Learn about the UpdateEntity endpoint in the DestinationEntity collection.

This API lets you update the details of an existing entity in your project, such as its name, description, type, and more.

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

API request

Parameters

Parameter	Description
tenantId	Unique identifier of the tenant responsible for the project.
Destination_Entity_Types_Id	Unique identifier that represents the entity type. This parameter can have the following values:
project_Domain_Id	Unique identifier of the project's domain. Note: Whether or not you need to enter the project domain ID depends on your user account; If you are working with a private solution, you might need to enter the project ID instead of the project domain ID. On the other hand, if you are working with a public solution, you might need to enter the project domain and function ID. This parameter can have the following values:
project_Function_Id	Unique identifier of the project's function. Note: Whether or not you need to enter the project function ID depends on your user account; If you are working with a private solution, you might need to enter the project ID instead of the project domain ID. On the other hand, if you are working with a public solution, you might need to enter the project domain and function ID. Based on the project's domain, this parameter can have the following values: For No domain (when project_Domain_Id is -1) For Security & Safety (when project_Domain_Id is 2) For Human wellbeing (when project_Domain_Id is 3) For Digital user experience (project_Domain_Id is 4)
updateId	Unique identifier of the entity that you want to update.
name	Name of the entity.
description	An explanation of what the entity is.
identifier	Unique identifier of the entity.