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

Authentication

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

Path Parameters

leadId
number
required
The unique identifier of the lead

Request Body Schema

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

Response Schema

id
number
The created note ID

Example Response

{
  "id": 123
}

Notes

  • Requires API key with write_access permission
  • Supports rich text formatting, attachments, and user mentions
  • Mentioned users receive notifications