Skip to main content
POST
/
v1
/
notes
Create Note
curl --request POST \
  --url https://api.example.com/v1/notes \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "content": "<string>",
  "note_type": "<string>",
  "tags": [
    {}
  ],
  "is_pinned": true,
  "contact_id": "<string>",
  "contact_name": "<string>",
  "related_company_id": "<string>",
  "company_name": "<string>",
  "deal_id": "<string>",
  "created_date": "<string>"
}
'
{
  "data": {}
}

Request

At least one parent link is required. A note must reference contact_id, related_company_id (a.k.a. company_id on the body), or deal_id. Orphan notes are rejected with 400.

Body Parameters

title
string
required
Note title
content
string
Note content (max 50,000 characters)
note_type
string
default:"general"
Note type: general, meeting, call, email, other
tags
array
Array of tag strings
is_pinned
boolean
default:"false"
Pin the note
contact_id
string
UUID of the linked contact. Must belong to your workspace.
contact_name
string
Human name — the server fuzzy-matches within your workspace and resolves to a contact_id. Use when an agent has a name but not a UUID. If multiple contacts match, returns 400 ambiguous_reference listing candidate UUIDs — retry with contact_id.
UUID of the linked company. (Also accepts company_id as an alias.)
company_name
string
Human name — same fuzzy resolution as contact_name but against the Company table.
deal_id
string
UUID of the linked deal.
created_date
string
Optional ISO 8601 timestamp. Honored verbatim if within the last 5 years and not more than 24 h in the future; otherwise the server now() is used. Never null.

Headers

Authorization: Bearer wbk_your_api_key_here
Content-Type: application/json

Response

data
object
Created note with id, title, note_type, tags, is_pinned, contact_id, related_company_id, deal_id, created_date.
curl -X POST https://data.leadlex.com/functions/v1/api-gateway/v1/notes \
  -H "Authorization: Bearer wbk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Call summary — Hans Müller",
    "content": "Discussed Q2 IP audit timeline.",
    "note_type": "call",
    "contact_id": "789e0123-e45b-67c8-a901-234567890abc",
    "created_date": "2026-04-10T12:00:00Z"
  }'

Errors

StatusCodeDescription
400validation_errorMissing title — or no parent link (contact_id / company_id / deal_id)
403insufficient_permissionsMissing contacts:write permission

Orphan-note rejection example

{
  "error": {
    "code": "validation_error",
    "message": "At least one parent link (contact_id, company_id, deal_id, or event_id) is required"
  }
}

Sub-resource alternative

If you already have a contact or company in hand, you can skip the parent-link body field and POST to the sub-resource endpoint:
  • POST /v1/contacts/{contact_id}/notes
  • POST /v1/companies/{company_id}/notes
Both accept the same body (minus the parent-link field) and enforce workspace scope on the path parameter.