v2

OpenAPI 3.1.02026-08-05123191254.3 KB
external-v2-notes

Create Placement Note

Create a note on a placement, attributed to the API key's user.

Placement notes carry NoteType.PLACEMENT_SHARED_NOTE — the broker-team outreach-context type the web app and AI recommendations also write (it is not shared with the borrower or lender). Internal placement notes are never created or exposed here. Note: the placement description field (PATCH /placements/<id>) also appends a shared note on change; these endpoints are the canonical way to manage a placement's note collection.

post/api/external/v2/placements/{placement_id}/notes

Path parameters

placement_idinteger required

Request body

textstring required

Note text. Simple HTML formatting is preserved; dangerous markup (scripts, javascript: URLs) is stripped server-side.

Response

Successful Response

request_idstring required
timestampstring required