---
title: "Add Note"
method: POST
path: "/v1/entities/{entity_id}/notes"
tags: ["entities"]
---

# Add Note

`POST /v1/entities/{entity_id}/notes`

## Request

- Base URL: `https://api.bitpoort.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.bitpoort.com/v1/entities/{entity_id}/notes`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

## Path parameters

- `entity_id` integer, required

## Request body

- NoteCreateRequest
  - `note` string, required
  - `note_type` string
  - `scope_address` string, nullable
  - `case_ref` string, nullable
  - `pinned` boolean

## Response `201`

Successful Response

- object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/bitpoort/apis/bitpoort-api.md) · [All operations](https://skmtc.dev/bitpoort/apis/bitpoort-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bitpoort/apis/bitpoort-api/revisions/1a51d8566777?raw)