---
title: "Edit extracted attribute value"
method: PATCH
path: "/internal/api/document/attribute/{attribute_id}"
tags: ["DOCUMENT"]
---

# Edit extracted attribute value

`PATCH /internal/api/document/attribute/{attribute_id}`

## Request

- Base URL: `https://api.signalshq.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.signalshq.io/internal/api/document/attribute/{attribute_id}`
- Auth: OAuth 2
  - Password
  - Token URL: `/auth/login`

Edit an extracted attribute value with datatype validation and audit tracking. The endpoint validates the new value against the attribute's datatype (if provided) and creates an audit record for the change. Version is incremented when the value or supported_attribute_id changes. Both new_value and supported_attribute_id are optional, but at least one must be provided. Optionally, provide supported_attribute_id to update the attribute mapping in the tenant_client_extracted_attributes table.

## Path parameters

- `attribute_id` string, uuid, required: Extracted attribute ID

## Request body

- AttributeEditRequest: Request schema for editing extracted attribute values
  - `client_id` string, uuid, required: Client ID for the attribute
  - `new_value` string, nullable: Optional new value for the attribute. If not provided, only supported_attribute_id will be updated if specified.
  - `change_reason` string, nullable: Optional reason for the change
  - `supported_attribute_id` string, uuid, nullable: Optional supported attribute ID to update the attribute mapping. If provided, the attribute_id in tenant_client_extracted_attributes will be updated.

## Response `200`

Successful Response

- AttributeEditResponse: Response schema for attribute edit operations
  - `id` string, uuid, required: Attribute ID
  - `attribute_value` string, nullable, required: Current attribute value
  - `version` integer, required: Current version number
  - `status` string, required: Current validation status
  - `confidence` number, nullable, required: Confidence score
  - `is_user_updated` boolean, required: Whether the value was updated by a user
  - `updated_at` string, required: Last update timestamp
  - `updated_by` string, required: User who last updated the attribute

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/signalshq/apis/signals-api.md) - [All operations](https://skmtc.dev/signalshq/apis/signals-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signalshq/apis/signals-api/revisions/2c22af3b5576?raw)