v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Entities

Update an Entity

Update an entity's name, relationship type, and properties. More details on managing an entity can be found in the Entity Overview article.

OAuth Scope required: public.entities.updateEntities

patch/entities/{id}

Path parameters

idstring required

The ID or Ironclad ID of the Entity to update.

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Request body

namestring

The name of the Entity.

relationshipTypeKeystring[]

The key of the relationship type to be added to the entity. The key must match a valid relationship type in the company settings. The key is displayed on the relationship types page in Data Manager and is always a single word without spaces that starts with a lowercase. For now, only one relationship type can be added or updated per entity. More info on relationship types can be found in the Entity Relationship Types article.

status'ACTIVE' | 'INACTIVE'

The status of the entity

addPropertiesobject

A key:value map of properties to add. More details on the properties can be found in the Entity Properties article.

removePropertiesstring[]

List of entity property ids to be removed from the entity record if they exist.

removeParentboolean

Boolean flag to indicate if the parent id should be removed for the current entity.

Example request

{
  "removeProperties": [
    "entity_externalID"
  ],
  "setParent": {
    "recordId": "123e4567-e89b-12d3-a456-426614174001"
  }
}

Response

200

idstring required

The unique identifier of the entity

ironcladIdstring required

The unique Ironclad identifier of the entity

namestring required

The name of the entity

statusstring required

The status of the entity

lastUpdatedstring required

The last updated date of the entity

propertiesRecordProperties required

The record properties associated with the record

namedTypeIdsstring[]

The unique identifiers of the relationship types associated with the entity

parentIdstring

The unique identifier of the parent entity

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "ironcladId": "ENTITY-1",
  "name": "Ironclad, Inc.",
  "status": "active",
  "lastUpdated": "2021-01-01T00:00:00Z",
  "namedTypeIds": [
    "43d3e321-e89b-12d3-a456-426614174000"
  ],
  "parentId": "123e4567-e89b-12d3-a456-426614174001"
}