DOCUMENT

Edit extracted attribute value

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.

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)
Auth
OAuth 2
Password
Token URL: /auth/login

Path parameters

attribute_idstring uuid required

Extracted attribute ID

Request body

client_idstring uuid required

Client ID for the attribute

new_valuestring nullable

Optional new value for the attribute. If not provided, only supported_attribute_id will be updated if specified.

change_reasonstring nullable

Optional reason for the change

supported_attribute_idstring uuid nullable

Optional supported attribute ID to update the attribute mapping. If provided, the attribute_id in tenant_client_extracted_attributes will be updated.

Example request

{
  "new_value": "12345",
  "change_reason": "Corrected OCR error",
  "supported_attribute_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response

Successful Response

idstring uuid required

Attribute ID

attribute_valuestring nullable required

Current attribute value

versioninteger required

Current version number

statusstring required

Current validation status

confidencenumber nullable required

Confidence score

is_user_updatedboolean required

Whether the value was updated by a user

updated_atstring required

Last update timestamp

updated_bystring required

User who last updated the attribute

Changes

No recorded changes to this operation across all 1 revision of this API.