niiko/developers

CRM v1 current

crm.note_added

Saves a note on a client's record, naming the client: something to know next time, with no call and no date. For a call use crm.call_logged; for a dated reminder, crm.task_created.

Last updated

POST /api/v1/actions/crm.note_added
Key scope
crm.note_added@1
Workspace permission
api.crm.note_added off by default
Two permissions, not one

Both are needed: a key with that scope, and the workspace owner having switched the permission on. Holding the key is not enough — they are two decisions made by different people.

Request

fieldtyperules
clientstringrequiredmin 1 · max 200
notestringrequiredmin 1 · max 2000

Response — output when status is done

fieldtyperules
clientIdstringrequired
clientNamestringrequired
noteIdstringrequired

Example

# One request, one idempotency key: retrying with the same key never runs twice.
curl -X POST https://niiko.org/api/v1/actions/crm.note_added \
  -H "Authorization: Bearer nk_…" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "client": "…",
    "note": "…"
  }'
# 200 → done · 202 → pending_approval (a person signs later) · 4xx → refused, with a named reason

Why it may refuse

Each reason names who can fix it and how. With reason stale, detail.message says what to do.

cliente_no_encontradocliente_ambiguodemasiados_clientessin_permiso

In the clients

@vorluno/niiko-sdkniiko.addedNote()
niiko (Python)niiko.added_note()
niiko-cliniiko run crm.note_added
n8n-nodes-niikocrmNoteAdded
niiko-mcp-servercrm_note_added

History