---
title: "Update Entity"
method: PATCH
path: "/api/v1/entities/{entity_id}"
tags: ["entities"]
---

# Update Entity

`PATCH /api/v1/entities/{entity_id}`

## Request

- Base URL: `https://api.gnosari.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gnosari.com/api/v1/entities/{entity_id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-AUTH-TOKEN`

Update an entity (attributes, status, notes).

## Path parameters

- `entity_id` integer, required

## Request body

- ExtractedEntityUpdate: Schema for updating an ExtractedEntity.
  - `attributes` object, nullable: Updated attribute values
  - `status` 'NEW' | 'REVIEWED' | 'ACTIONED' | 'ARCHIVED': Status of an extracted entity in the workflow.
  - `notes` string, nullable: User notes

## Response `200`

Successful Response

- ExtractedEntityRead: Standard read schema -- used in list responses and simple reads.
  - `id` integer, required
  - `entity_type_id` integer, required
  - `agent_id` integer, required
  - `session_id` string, nullable, required
  - `attributes` object, required
  - `confidence_score` number, nullable, required
  - `status` 'NEW' | 'REVIEWED' | 'ACTIONED' | 'ARCHIVED', required: Status of an extracted entity in the workflow.
  - `is_manual` boolean, required
  - `notes` string, nullable, required
  - `account_id` integer, required
  - `entity_type_name` string, nullable
  - `entity_type_icon` string, nullable
  - `agent_name` string, nullable
  - `session_channel` string, nullable
  - `display_name` string, nullable
  - `contact_email` string, nullable
  - `contact_phone` string, nullable
  - `display_summary` string, nullable
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/gnosari/apis/gnosari-api.md) · [All operations](https://skmtc.dev/gnosari/apis/gnosari-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gnosari/apis/gnosari-api/revisions/f299cf53ae5f?raw)