Skip to main content
PATCH
Update a vault

Authorizations

Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Path Parameters

id
string<uuid>
required

The vault ID

Body

application/json
name
string

New vault name

Required string length: 1 - 200
description
string | null

New description. Send null to clear it.

Maximum string length: 1000
is_access_controlled
boolean

When true, only vault members can see the vault. When false, any member of the organization with organization-wide vault read can see it as a viewer. Changing this adds and removes no members: it only opens or closes the organization-wide path.

Response

The updated vault

id
string<uuid>
required

Unique vault identifier

name
string
required

Vault name

Example:

"Vendor SaaS agreements"

description
string | null
required

Vault description, or null if unset

my_role
enum<string>
required

Caller's role in this vault: owner (manage members and settings), editor (add documents and edit extracted data), or viewer (read and annotate). A vault the caller reaches only through organization-wide visibility reports viewer. The role is not the whole story for writes: adding documents also needs the organization-level permission to manage vaults, so a caller can hold editor here and still receive 403 from POST /vaults/{id}/documents.

Available options:
owner,
editor,
viewer
is_access_controlled
boolean
required

When true, only vault members can see the vault. When false, any member of the organization with organization-wide vault read can see it.

document_count
number
required

Documents that have finished scanning in this vault. Documents still being read are not counted yet.

setup_completed_at
string | null
required

ISO 8601 timestamp when guided setup finished, or null while the vault is still in setup. Documents added to a vault in setup are stored but not scanned until setup finishes. Vaults created through POST /vaults finish setup immediately, so this is always set for them.

archived_at
string | null
required

ISO 8601 timestamp when the vault was archived, or null while it is live. Archived vaults are hidden from the default list and reject changes until POST /vaults/{id}/restore runs.

created_at
string
required

ISO 8601 creation timestamp

updated_at
string
required

ISO 8601 last-update timestamp

Last modified on September 25, 2026