Skip to content
Engram Docs

Update a vault

PATCH
/vaults/{id}
curl --request PATCH \
  --url https://api.engram.page/vaults/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "is_default": true, "name": "Research (renamed)" }'

Updates a vault’s name or is_default flag and returns the updated vault. Returns 404 when no such vault exists and 422 on validation errors.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Vault UUID

Request Bodyrequired

Section titled “Request Bodyrequired”

Fields to change

Media typeapplication/json
UpdateVaultRequest
object
is_default
boolean
name
string

Example 

{
  "is_default": true,
  "name": "Research (renamed)"
}

Responses

Section titled “Responses”

200

Section titled “200”

Updated

Media typeapplication/json
VaultResponse
object
vault
required
Vault
object
attachment_count
integer
created_at
string format: date-time
nullable
deleted_at
string format: date-time
nullable
encrypted

Always true — vaults are encrypted at rest.

boolean
id
required
string format: uuid
is_default
boolean
name
required
string
note_count
integer
populated

True once the vault holds a note other than the seeded welcome note (the moment the vault_populated event fires).

boolean
purge_at

When a soft-deleted vault is hard-purged (deleted_at + 30d).

string format: date-time
nullable
slug
string
nullable

Example generated

{
  "vault": {
    "attachment_count": 1,
    "created_at": "2026-04-15T12:00:00Z",
    "deleted_at": "2026-04-15T12:00:00Z",
    "encrypted": true,
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "is_default": true,
    "name": "example",
    "note_count": 1,
    "populated": true,
    "purge_at": "2026-04-15T12:00:00Z",
    "slug": "example"
  }
}

403

Section titled “403”

Vault only readable by the credential: this needs write access to the vault

Media typeapplication/json
MessageError
object
error
required
string

Example 

{
  "error": "not found"
}

404

Section titled “404”

No such vault, or one the credential cannot reach (the two look the same)

Media typeapplication/json
MessageError
object
error
required
string

Example 

{
  "error": "not found"
}

422

Section titled “422”

Validation error

Media typeapplication/json
Error
object
errors
One of:
string

Example generated

{
  "errors": {}
}