Skip to main content
PATCH
Update a note

Authorizations

Authorization
string
header
required

OAuth 2.0 authorization code flow with PKCE (S256). See the authorization guide.

Scopes

notes:write

Create, update and delete your notes

Path Parameters

note_id
string<uuid>
required

Body

application/json

A field left out is unchanged.

tag_ids
string<uuid>[]

Active same-firm tag ids. Requires the resource write scope, not tags:write. Omit to preserve, [] to clear; null is rejected. Replaces the entire tag set.

Maximum array length: 100
title
string
Required string length: 1 - 250
body
string

Markdown or plain text. HTML is rejected.

Required string length: 1 - 100000

Response

The updated note.

tags
object[]
required
is_external
boolean
required
read-only

True when this record has an active integration link, including an export from Vega. This is current linkage, not historical origin, and is independent of linked contacts or households. Associated records cannot be patched or deleted through this API, except that a meeting may patch reviewed alone. No provider/account details are exposed.

id
string<uuid>
required
title
string
required
body
string | null
required

Markdown. A note written in Vega's editor is converted to Markdown.

contacts
object[]
required

The linked contacts the user can see.

households
object[]
required

The linked households the user can see.

created_on
string<date-time>
required
updated_on
string<date-time>
required