API ReferenceLists

Archive a custom list

Archives a list. Fails if the list is in use by active workflows.

Authentication

X-API-Keystring

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

Path parameters

list_idstringRequired

Headers

Verifa-VersiondateOptional

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

Response

List archived.
idstring
namestring
list_typestring
match_modestring
item_countinteger
is_activeboolean
created_atdatetime
org_idstring
descriptionstring or null
updated_atdatetime

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error