POST /v1/crm/deals/{deal_id}/notes

Add a note to a deal, signed as from the API.

Adds a note to a deal. It shows on the deal’s page beside your team’s notes, signed API · <key name>.

Needs the crm.deals:write scope.

Path parameters

Field	Type	Required	Notes
deal_id	string	Yes	The deal’s id.

Body

Field	Type	Required	Notes
body	string	Yes	The note. Up to 4,000 characters; not empty.

Request

cURL

curl -X POST "https://api.fireflo.au/v1/crm/deals/5b2e8c1d-7a4f-4e3b-9c6d-1f0a2b3c4d5e/notes" \
  -H "Authorization: Bearer $OMNI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "Quote sent: ₹1,18,000 incl. installation."
}'

Response

201 Created — the note.

{
  "id": 213,
  "body": "Quote sent: ₹1,18,000 incl. installation.",
  "author": "API · Billing sync",
  "created_at": "2026-10-06T09:30:41+05:30"
}

Errors

Every refusal is {"error": {"code", "message", "field"}}; field is there when one input is at fault.

Status	Error code	When
400	invalid_request	body is missing, empty or longer than 4,000 characters (field is body).
404	not_found	No deal of this account’s has that id.
404	module_off	The account doesn’t have Pipelines on.
403	scope_missing	The key doesn’t have the crm.deals:write scope.

Any request can also be refused for its key, its account or its rate (key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.