Skip to Content
CallMitraDocs
API referenceLead notes

Pin a note

At most three notes per lead can be pinned; a fourth returns 409 `lead_note_pin_limit`.

POST
/api/v1/leads/{lead_id}/notes/{note_id}/pin

At most three notes per lead can be pinned; a fourth returns 409 lead_note_pin_limit.

Authorization

headerX-API-Key<token>

Create in the console: Settings → API & webhooks.

Path Parameters

lead_id*Lead Id

Lead ID.

note_id*Note Id

Note ID, from GET /leads/{leadId}/notes.

Response Body

OK

application/json
  1. response

The note after the change.

note?|

The note.

notesCount?|

Live notes on the lead (on create).

success?|

Always true.

[key: string]?any
Example Request
curl -X POST 'https://api.callmitra.ai/api/v1/leads/string/notes/string/pin'
Example Response
{  "note": {    "authorKind": "api",    "body": "Asked for a call back after 6pm.",    "createdAt": "2026-05-04T10:15:00Z",    "id": "8a1f3c2e-5b7d-4e0a-9c61-2d4b8e7f0a13",    "kind": "note",    "leadId": "3f2c9d6e-1a4b-4c8d-9e0f-7a6b5c4d3e21",    "pinned": true,    "pinnedAt": "2026-05-04T11:05:00Z",    "updatedAt": "2026-05-04T10:15:00Z",    "version": 2  },  "success": true}