API ReferenceDocument Types

Update a document group

Updates mutable fields on a document group.

Required scope: settings:write

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

group_idstringRequired
Document group ID.

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Request

This endpoint expects an object.
namestringOptional

Human-readable group name.

descriptionstring or nullOptional
Description of this group.
classificationslist of stringsOptional
Document classifications included in this group.
extraction_configmap from strings to any or nullOptional
Extraction configuration for this group.
check_configmap from strings to any or nullOptional
Check suite configuration for this group.
recency_configmap from strings to any or nullOptional

Recency/expiry rules for this group.

is_defaultbooleanOptional
Whether this is the default group for unmatched documents.
is_activebooleanOptional
Whether this group is active.
priorityintegerOptional

Evaluation priority order (lower is higher priority).

Response

Document group updated.
idstring
Document group ID.
org_idstring
Organization ID.
namestring

Human-readable group name.

is_defaultboolean
Whether this is the default group for unmatched documents.
is_activeboolean
Whether this group is active.
priorityinteger

Evaluation priority order (lower is higher priority).

created_atdatetime
updated_atdatetime
descriptionstring or null
Description of this group.
classificationslist of strings
Document classifications included in this group.
extraction_configmap from strings to any or null
Extraction configuration applied to documents in this group.
check_configmap from strings to any or null
Check suite configuration for documents in this group.
recency_configmap from strings to any or null

Recency/expiry rules for documents in this group.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error