Skip to main content
All requests use a single endpoint: POST https://api.helpgenie.ai/v1 with resource: "lead-notes".

Access control

All operations require authentication. Access is granted if the user owns the lead (via the lead’s agent) or is an internal admin. Non-owners receive a 403 Forbidden response.

List notes

Retrieves all notes for a specific lead. Pinned notes appear first in the results.
Pinned notes always appear at the top of list results regardless of pagination or creation date. Use the togglePin action or set is_pinned: true on update to pin important notes so they are never buried.
string
required
Must be "lead-notes"
string
required
Must be "list"
object
required

Response

boolean
object

Get a note

Retrieves a specific note by ID.
string
required
Must be "lead-notes"
string
required
Must be "get"
string
required
The note UUID.

Response

boolean
object

Create a note

Creates a new note for a lead.
string
required
Must be "lead-notes"
string
required
Must be "create"
object
required

Response (status 201)

boolean
object

Update a note

Updates an existing note. Only content and is_pinned fields can be modified.
string
required
Must be "lead-notes"
string
required
Must be "update"
string
required
The note UUID.
object
required

Response

boolean
object

Delete a note

Permanently deletes a note.
string
required
Must be "lead-notes"
string
required
Must be "delete"
string
required
The note UUID.

Response

boolean
object

Toggle pin status

Toggles the pinned status of a note. If the note is pinned it becomes unpinned, and vice versa.
string
required
Must be "lead-notes"
string
required
Must be "togglePin"
string
required
The note UUID.

Response

boolean
object

Get pinned notes

Retrieves all pinned notes for a specific lead.
string
required
Must be "lead-notes"
string
required
Must be "pinned"
object
required

Response

boolean
object

Note object

string
UUID of the note.
number
ID of the lead this note belongs to.
string | null
ID of the user who created the note.
string
The note text.
boolean | null
Whether the note is pinned. Pinned notes sort first in list results.
string | null
ISO 8601 timestamp.
string | null
ISO 8601 timestamp.

Error responses