Notes API

Create a note

Create a note linked to workspace resources.

POST/v1/notes

capability notes.create · v1health dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

titlestringrequired
bodymin length 1max length 200
contentstring
bodydefault ""max length 100000
linksone of 2 shapes[]
bodydefault []max items 50
- kind"patient"required
- resourceIdstring<uuid>required

Response

Successful responses use Dawn's data envelope.

dataNoterequired
- idstring<uuid>required
- workspaceIdstring<uuid>required
- titlestringrequired
  min length 1max length 200
- contentstringrequired
  max length 100000
- linksone of 2 shapes[]required
  max items 50
  - kind"patient"required
  - resourceIdstring<uuid>required
- createdAtstring<date-time>required
- updatedAtstring<date-time>required
metaobject

Errors

Error responses use the shared error envelope.

403Notes are disabled or a workspace member is required.
422The note or one of its links is invalid.
503The note could not be saved.

Request

import { createDawnClient } from "@dawn/api";

const dawn = createDawnClient({
  baseUrl: "http://localhost:6400",
});

const result = await dawn.capabilities["notes.create"]({
  "title": "Ada Lovelace",
  "content": "",
  "links": [],
});

if (result.isErr()) throw result.error;
console.log(result.value);

Response

Created.

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "workspaceId": "22222222-2222-4222-8222-222222222222",
    "title": "Ada Lovelace",
    "content": "string",
    "links": [
      {
        "kind": "patient",
        "resourceId": "11111111-1111-4111-8111-111111111111"
      }
    ],
    "createdAt": "2026-08-01T09:00:00.000Z",
    "updatedAt": "2026-08-01T09:00:00.000Z"
  },
  "meta": {}
}