PATCH
/
api
/
v1
/
leads
/
{leadId}
/
notes
/
{noteId}
Update Lead Note
curl --request PATCH \
  --url https://app.journeybee.io/api/v1/leads/{leadId}/notes/{noteId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "document": {},
  "attachments": [
    {}
  ],
  "mentions": [
    {}
  ]
}'
{
  "id": 123,
  "updated_at": "<string>"
}

Authentication

curl -X PATCH "https://app.journeybee.io/api/v1/leads/{leadId}/notes/{noteId}" \
  -H "Authorization: Bearer your-api-key-uuid" \
  -H "Content-Type: application/json" \
  -d '{"document": {"type": "doc", "content": [{"type": "paragraph", "content": [{"type": "text", "text": "Updated follow-up notes"}]}]}}'

Path Parameters

leadId
number
required
The unique identifier of the lead
noteId
number
required
The unique identifier of the note to update

Request Body Schema

document
object
Updated rich text document content in ProseMirror format
attachments
array
Updated array of file attachment UUIDs
mentions
array
Updated array of user IDs to mention (triggers notifications)

Response Schema

id
number
The updated note ID
updated_at
string
Timestamp of when the note was last updated

Notes

  • Requires API key with write_access permission
  • New mentions trigger notifications