Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.lofty.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Usage: lofty-cli notes [options] [command]

Manage notes

Options:
  -h, --help                  display help for command

Commands:
  get [options] <note-id>     Get note by Id
  update [options] <note-id>  Update a note
  delete [options] <note-id>  Delete a note
  list [options]              Search for notes
  create [options]            Add a note
  help [command]              display help for command

​
lofty-cli notes get

Usage: lofty-cli notes get [options] <note-id>

Get note by Id

Options:
  --fields <cols>  Comma-separated columns to display
  --json           Output as JSON
  --format <fmt>   Output format: text, json, csv, yaml
  -h, --help       display help for command

​
lofty-cli notes update

Usage: lofty-cli notes update [options] <note-id>

Update a note

Options:
  --content <content>  [REQUIRED] Note content (string, e.g. example_note)
  --lead-id <id>       [REQUIRED] The ID of the lead this note is related to
                       (number, e.g. 563172647619608)
  --is-pin <bool>      Pin this note or not (true|false)
  --fields <cols>      Comma-separated columns to display
  --json               Output as JSON
  --format <fmt>       Output format: text, json, csv, yaml
  -h, --help           display help for command

​
lofty-cli notes delete

Usage: lofty-cli notes delete [options] <note-id>

Delete a note

Options:
  --fields <cols>  Comma-separated columns to display
  --json           Output as JSON
  --format <fmt>   Output format: text, json, csv, yaml
  -h, --help       display help for command

​
lofty-cli notes list

Usage: lofty-cli notes list [options]

Search for notes

Options:
  --lead-id <id>                [REQUIRED] ID of Lead (number)
  --include-system-note <bool>  Include System note or not (true|false)
  --fields <cols>               Comma-separated columns to display
  --json                        Output as JSON
  --format <fmt>                Output format: text, json, csv, yaml
  -h, --help                    display help for command

​
lofty-cli notes create

Usage: lofty-cli notes create [options]

Add a note

Options:
  --content <content>  [REQUIRED] Note content (string, e.g. example_note)
  --lead-id <id>       [REQUIRED] The ID of the lead this note is related to
                       (number, e.g. 563172647619608)
  --is-pin <bool>      Pin this note or not (true|false)
  --fields <cols>      Comma-separated columns to display
  --json               Output as JSON
  --format <fmt>       Output format: text, json, csv, yaml
  -h, --help           display help for command