Skip to main content
DELETE
Clear document family status

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

Updated document family

A document family groups related content objects representing a single logical document, tracking its processing lifecycle.

appliedKnowledgeSets
object[] | null
required
changeSequence
integer<int32>
required

Optimistic locking version number.

contentObjects
object[] | null
required

Content objects belonging to this document family, ordered by index.

created
string<date-time> | null
required

Original file creation date.

createdOn
string<date-time>
required

Timestamp when the document family was created.

deleted
boolean
required

Whether the document family has been soft-deleted.

documentStatus
object | null
required

Current processing status of the document.

documentTaxonValidations
object[] | null
required

Validation results against the document taxonomy.

executionTargets
object
required

Processing execution targets for this document.

features
object[] | null
required
id
string
required

Unique identifier (UUID) for the document family.

Example:

"b1234567-89ab-cdef-0123-456789abcdef"

labels
object[] | null
required
locked
boolean
required

Whether the document family is locked for processing.

metadata
object | null
required

Document metadata extracted during processing.

metadataSource
object | null
required

Maps metadata keys to their source content object IDs.

mixins
string[] | null
required
modified
string<date-time> | null
required

Original file modification date.

path
string
required

File path or name of the document.

Example:

"invoices/2025/q4/invoice-001.pdf"

pendingProcessing
boolean
required

Whether the document family is queued for processing.

size
integer<int64>
required

File size in bytes.

Example:

245760

statistics
object | null
required

Document family statistics contain processing metrics for a document family.

storeRef
string
required

Reference to the document store containing this document family.

summary
string
required

AI-generated summary of the document content.

tasks
object[] | null
required
updatedOn
string<date-time>
required

Timestamp when the document family was last updated.

uuid
string
required

Secondary UUID identifier.

deleteUserEmail
string | null

Email of the user who deleted the document family.

deletedDate
string<date-time> | null

Timestamp when the document family was soft-deleted.

lockedAt
string<date-time> | null
lockedById
string | null
originalPath
string | null

Original path before soft-deletion or rename.