---
title: "Update an Entity Attribute"
method: PUT
path: "/catalog/v1/entity"
tags: ["Entity (v1)"]
---

# Update an Entity Attribute

`PUT /catalog/v1/entity`

[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

Partially update an entity attribute.

## Request body

- EntityWithExtInfo
  - `referredEntities` object — The referred entities
  - `entity` Entity — The entity
    - `typeName` string — The type name
    - `attributes` object — The type attributes
    - `guid` string — The internal guid
    - `homeId` string — The home id
    - `isProxy` boolean — Whether is a proxy
    - `isIncomplete` boolean — Whether is incomplete
    - `provenanceType` integer — The provenance type
    - `status` 'ACTIVE' | 'DELETED' | 'PURGED' — The status
    - `createdBy` string — The creator
    - `updatedBy` string — The updater
    - `createTime` integer — The create time
    - `updateTime` integer — The update time
    - `version` integer — The version
    - `relationshipAttributes` object — The relationship attributes
    - `classifications` Classification[] — The classifications (tags)
      - `typeName` string — The tag name
      - `attributes` object — The tag attributes
      - `entityGuid` string — The internal entity guid
      - `entityStatus` 'ACTIVE' | 'DELETED' | 'PURGED' — The entity status
      - `propagate` boolean — Whether to propagate the tag
      - `validityPeriods` TimeBoundary[] — The validity periods
        - `startTime` string — The start time of format yyyy/MM/dd HH:mm:ss
        - `endTime` string — The end time of format yyyy/MM/dd HH:mm:ss
        - `timeZone` string — The time zone (see java.util.TimeZone)
      - `removePropagationsOnEntityDelete` boolean — Whether to remove propagations on entity delete
    - `meanings` TermAssignmentHeader[] — The meanings
      - `termGuid` string — The term guid
      - `relationGuid` string — The relation guid
      - `description` string — The description
      - `displayText` string — The display text
      - `expression` string — The expression
      - `createdBy` string — The creator
      - `steward` string — The steward
      - `source` string — The source
      - `confidence` integer — The confidence
      - `status` 'DISCOVERED' | 'PROPOSED' | 'IMPORTED' | 'VALIDATED' | 'DEPRECATED' | 'OBSOLETE' | 'OTHER' — The status
    - `customAttributes` object — The custom attributes
    - `businessAttributes` object — The business attributes
    - `labels` string[] — The labels
    - `proxy` boolean — Whether is a proxy

## Response `200`

The updated entity

- EntityPartialUpdateResponse — The type name
  - `mutatedEntities` EntityPartialUpdate — The updated entities.
    - `UPDATE` PartialUpdateParams[] — The updated entities.
      - `typeName` string — The type name
      - `attributes` object — The attributes
      - `guid` string — The internal guid
      - `status` 'ACTIVE' | 'DELETED' | 'PURGED' — The status
      - `classificationNames` string[] — The classification (tag) names
      - `classifications` ClassificationHeader[] — The classifications (tags)
        - `typeName` string — The tag name
        - `entityGuid` string — The internal entity guid
        - `entityStatus` 'ACTIVE' | 'DELETED' | 'PURGED' — The entity status
        - `propagate` boolean — Whether to propagate the tag
        - `removePropagationsOnEntityDelete` boolean — Whether to remove propagations on entity delete
      - `isIncomplete` boolean — Whether is incomplete

## Other responses

- `400` — Bad Request
- `404` — Entity not found
- `429` — Rate Limit Error
- `500` — Internal Server Error

---

[API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)