Skip to main content
PATCH
Edit the File note

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Path Parameters

meeting
string
required

The meeting id, from list_meetings.

Required string length: 1 - 60

Body

application/json
summary
string | null

Up to 20,000 characters.

Maximum string length: 40000
decisions
object[] | null

Up to 50 decisions.

Maximum array length: 100
agenda_covered
string[] | null

Agenda item ids from get_meeting.

Maximum array length: 200
Maximum string length: 60

Response

Success.

object
enum<string>
required
Available options:
file_note
id
string | null
required

Null before there is a note.

meeting_id
string
required
client_id
string
required
status
enum<string>
required

none before a note is drafted or written; draft until a member confirms it.

Available options:
none,
draft,
confirmed
origin
enum<string> | null
required

Drafted from the transcript, or written by a member.

Available options:
drafted,
written
summary
string
required
decisions
object[]
required
agenda_covered
string[]
required

The agenda item ids the meeting covered.

confirmed_by_name
string | null
required
confirmed_at
string | null
required

An ISO 8601 time in UTC.

updated_at
string | null
required

An ISO 8601 time in UTC.

revision_count
number
required

Edits made after it was confirmed. list_file_note_revisions has each one.

draft
object | null
required

The latest draft asked for.