---
title: "Update an Entity"
method: PATCH
path: "/entities/{id}"
tags: ["Entities"]
---

# Update an Entity

`PATCH /entities/{id}`

Update an entity's name, relationship type, and properties. More details on managing an entity can be found in the [Entity Overview](https://support.ironcladapp.com/hc/en-us/articles/28004816859543-Create-and-Manage-Entities) article. 

**OAuth Scope required:** `public.entities.updateEntities`

## Path parameters

- `id` string, required

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Request body

- object
  - `name` string — The name of the Entity.
  - `relationshipTypeKey` string[] — 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](https://support.ironcladapp.com/hc/en-us/articles/28005038398231-Create-Manage-Relationship-Types-and-Entity-Properties) article.
  - `status` 'ACTIVE' | 'INACTIVE' — The status of the entity
  - `addProperties` object — A key:value map of properties to add. More details on the properties can be found in the [Entity Properties](https://support.ironcladapp.com/hc/en-us/articles/28005038398231-Create-Manage-Relationship-Types-and-Entity-Properties) article.
  - `removeProperties` string[] — List of entity property ids to be removed from the entity record if they exist.
  - `setParent` object — Object containing Record ID or Ironclad ID to be set as the parent of the current entity.
    - `recordId` string, required
  - `removeParent` boolean — Boolean flag to indicate if the parent id should be removed for the current entity.

## Response `200`

200

- EntityModel
  - `id` string, required — The unique identifier of the entity
  - `ironcladId` string, required — The unique Ironclad identifier of the entity
  - `name` string, required — The name of the entity
  - `status` string, required — The status of the entity
  - `lastUpdated` string, required — The last updated date of the entity
  - `properties` RecordProperties, required — The record properties associated with the record
  - `namedTypeIds` string[] — The unique identifiers of the relationship types associated with the entity
  - `parentId` string — The unique identifier of the parent entity

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403
- `404` — 404

---

[API](https://skmtc.net/ironcladapp/apis/ironclad-public-api.md) · [All operations](https://skmtc.net/ironcladapp/apis/ironclad-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ironcladapp/ironclad-public-api/versions/9459b4cfc1e0/schema)